Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mitodl/edx-api-client
Python interface for edX REST APIs
https://github.com/mitodl/edx-api-client
edx
Last synced: 6 days ago
JSON representation
Python interface for edX REST APIs
- Host: GitHub
- URL: https://github.com/mitodl/edx-api-client
- Owner: mitodl
- License: agpl-3.0
- Created: 2016-03-22T19:24:51.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2024-11-16T05:26:43.000Z (about 1 month ago)
- Last Synced: 2024-11-29T15:45:58.723Z (25 days ago)
- Topics: edx
- Language: Python
- Homepage:
- Size: 169 KB
- Stars: 5
- Watchers: 27
- Forks: 2
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# edx-api-client
[](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.
The Course Enrollment integration tests have the following requirements:
- The user assigned to that `ACCESS_TOKEN` must be an admin in the edX demo course.
Adding a user as an admin can be done in Studio (url: `/course_team/course-v1:edX+DemoX+Demo_Course`
## Release Notes
See the RELEASE.rst file