edx-rest-api-client

What it is and what it does

edx-rest-api-client is a wrapper around the requests library that handles OAuth2 authentication and JWT token management for communicating with Open edX platform services. It provides the OAuthAPIClient class, which behaves like a requests.Session but automatically manages token retrieval and caching, reducing boilerplate in services that need to call other Open edX APIs.

The package is built for the Open edX ecosystem and depends on edx-django-utils for its TieredCache caching layer. It requires Django caching and middleware to be configured. You instantiate a client with an LMS root URL, client ID, and secret, then use it like any requests session—the library handles token refresh transparently. Timeout configuration is supported both at client creation and per-request.

Use it for:

• Build an Open edX microservice that needs to call the LMS or other platform APIs with OAuth2 authentication.
• Integrate a third-party tool with Open edX by handling token management and REST calls automatically.
• Develop a Django app within the Open edX platform that communicates with other platform services.
• Cache and reuse OAuth2 tokens across multiple API requests to reduce token endpoint load.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Provides OAuth2 and JWT utilities for communicating with Open edX services via REST APIs, wrapping the requests library with token management and caching.

Yes, if you are building within or integrating with the Open edX platform and need OAuth2-authenticated REST calls. The low install friction, active maintenance, permissive license, and zero known vulnerabilities make it a safe choice. Not relevant for non-Open edX projects.

Install

edx-rest-api-client on PyPI

pip install edx-rest-api-client

uv add edx-rest-api-client

poetry add edx-rest-api-client

Installing edx-rest-api-client

Before you install

Low friction installation with three runtime dependencies (PyJWT, edx-django-utils, requests). Actively maintained with a release 128 days ago and continuous repository activity.

License in practice

Licensed under Apache (permissive), allowing commercial use, modification, and distribution with minimal restrictions.

Quickstart

from edx_rest_api_client.client import OAuthAPIClient

client = OAuthAPIClient('https://lms.root', 'client_id', 'client_secret')
response = client.get('https://some.url', timeout=(3.1, 0.5))

Requires Django caching and TieredCache middleware (from edx-django-utils) to be configured in your Django project.

Verify before relying

• Whether the package works outside a Django environment or if Django is a hard requirement.
• Current test coverage and stability guarantees for production use beyond the 'Production/Stable' classifier.

Package facts

Evidence: edx_rest_api_client-7.0.0-py3-none-any.whl

Keywords: edx, rest, api, client

Tags

More Internet packages