Skip to main content

Python interface to the edX REST APIs

Project description

# edx-api-client [![codecov.io](https://codecov.io/github/mitodl/edx-api-client/coverage.svg?branch=master)](https://codecov.io/github/mitodl/edx-api-client?branch=master) Python interface for edX REST APIs

## Installation

To get the latest stable release from PyPi

`bash pip install edx-api-client `

To get the latest commit from GitHub

`bash pip install -e git+git://github.com/mitodl/edx-api-client.git#egg=edx-api-client `

## Tests

If you’re going to run integration tests, you’ll need to specify the ACCESS_TOKEN environment variable to a valid access token.

You can create an access token (and the associated oauth app, and grant) through the edX admin.

If you’re going to run the integration tests against localhost, you’ll additionally need to turn off TLS validation with the environment variable OAUTHLIB_INSECURE_TRANSPORT=1. This will skip the HTTPS validation which is required by the OAuth spec.

Your edx demo course (course id course-v1:edX+DemoX+Demo_Course) must be enabled for CCX.

## Release Notes

See the RELEASE.rst file

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

edx-api-client-0.4.0.tar.gz (39.2 kB view details)

Uploaded Source

File details

Details for the file edx-api-client-0.4.0.tar.gz.

File metadata

File hashes

Hashes for edx-api-client-0.4.0.tar.gz
Algorithm Hash digest
SHA256 866e2209fbd50982a5628492846b8e7bdded0bbb2dded990853867db80e96001
MD5 5ebed5da9f9102901e6ab49a8b09a9d0
BLAKE2b-256 64eb1fe202bca9126f5d1a893905319e9a8af1d383edbcc0912cb826b9d39332

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page