{"id":17183944,"url":"https://github.com/jramnai/openedx-api-wrapper","last_synced_at":"2025-09-08T11:13:36.145Z","repository":{"id":45368334,"uuid":"383184020","full_name":"jramnai/openedx-api-wrapper","owner":"jramnai","description":"Python client library for Open edX REST APIs","archived":false,"fork":false,"pushed_at":"2021-12-17T10:54:35.000Z","size":10,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-26T22:48:51.892Z","etag":null,"topics":["edx","oauth2-client","openedx","rest-api"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jramnai.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-07-05T15:20:07.000Z","updated_at":"2021-08-07T03:52:44.000Z","dependencies_parsed_at":"2022-09-22T23:50:48.488Z","dependency_job_id":null,"html_url":"https://github.com/jramnai/openedx-api-wrapper","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/jramnai/openedx-api-wrapper","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jramnai%2Fopenedx-api-wrapper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jramnai%2Fopenedx-api-wrapper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jramnai%2Fopenedx-api-wrapper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jramnai%2Fopenedx-api-wrapper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jramnai","download_url":"https://codeload.github.com/jramnai/openedx-api-wrapper/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jramnai%2Fopenedx-api-wrapper/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274174271,"owners_count":25235203,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-08T02:00:09.813Z","response_time":121,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["edx","oauth2-client","openedx","rest-api"],"created_at":"2024-10-15T00:42:01.955Z","updated_at":"2025-09-08T11:13:36.120Z","avatar_url":"https://github.com/jramnai.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Open edX REST API Wrapper\n\nPython Wrapper around the [Open edX LMS/Studio](https://github.com/edx/edx-platform) REST APIs.\n\nThis work is inspired by [zoomus](https://github.com/prschmid/zoomus) (Python Wrapper around zoom.us REST APIs) and [Open edX REST API client ](https://github.com/aulasneo/openedx-rest-api-client) created by Andrés.\n\nI shamelessly copied most of the code from Braden MacDonald's [GitHubGist](https://gist.github.com/bradenmacdonald/930c7655dca32dc648af9cb0aed4a7c5).\n\n# Prerequisite (to be achieved on Open edX instance)\n\n### Enable Mobile Application Features\n\n1. In `/edx/etc/lms.yml` and `/edx/etc/studio.yml` files, add the following lines to the features section (just enable flags if already added).\n    ```\n    FEATURES:\n        ENABLE_MOBILE_REST_API: true\n        ENABLE_OAUTH2_PROVIDER: true\n        ENABLE_COMBINED_LOGIN_REGISTRATION: true\n    ```\n2. Save the files and restart the services.\n\n### Create a new OAuth Application\n\n1.  Log in to the Django administration console for your base URL. For example,  `http://{your_URL}/admin`.\n2. In **Django OAuth Toolkit** section select **Applications**.\n3.  Select  **Add Application**. A dialog box opens with the  **Client id**  and  **Client secret**  populated for the new application.\n4.  For the  **Client type**, select  **Public**.\n5.  Optionally, enter a  **User**  and an identifying  **Name**.\n6.  Select  **Save**.\n\nUse above generated **Client id** and **Client secret** to create Open edX REST API Client\n\n# Usage\n\n```python\n# Import Open edX REST API client\nfrom openedx_api_wrapper.client import OpenedxAPIClient\n# Create client with lms URL, studio URL, client_id, client_secret\nclient = OpenedxAPIClient(\n    'http://localhost:18000',\n    'http://localhost:18010',\n    'client_id',\n    'client_secret'\n)\n# Get username\nclient.user.get_username()\n```\n# Available methods\n- client.user.get_username()\n- client.user.get_user_details(username)\n- client.user.registration({\"name\":\"john\", \"username\":\"johnd\", \"email\":\"john.doe@example.com\", \"password\":\"edx\", \"country\":\"IN\", \"honor_code\":True})\n\n# Future Work\n- Publish on [PyPI](https://pypi.org/)\n- Add tests\n- Gradually add more REST API endpoints from [edx-plafrom](https://github.com/edx/edx-platform)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjramnai%2Fopenedx-api-wrapper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjramnai%2Fopenedx-api-wrapper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjramnai%2Fopenedx-api-wrapper/lists"}