Registry / web-framework / edx-api-doc-tools

edx-api-doc-tools

library3.0.0pypypiunverified

Tools for writing and generating API documentation for edX REST APIs. Current version 3.0.0 (dropped Python 3.11 support). Release cadence: irregular, with major version bumps for Python/Django support drops.

web-framework devops data serialization

pip install edx-api-doc-tools

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · EDX-API-DOC-TOOLS

edx-api-doc-tools

web-frameworkpythonv3.0.0

Install

4.6s avg

Import

—

Disk

97MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v3.0.0 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.95 runs

installs and imports cleanly · install 0.0s · import 0.000s · 93.7MB

glibc

py 3.10–3.95 runs

installs and imports cleanly · install 4.6s · import 0.000s · 95MB

97MB installed

● package 97MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

create_api_doc

✓ from edx_api_doc_tools import create_api_doc

✗ from edx_api_doc_tools import create_api_doc

Basic usage of the create_api_doc decorator to generate OpenAPI documentation from docstrings.

from edx_api_doc_tools import create_api_doc def my_api_view(request): """ GET /api/v1/resource Returns a list of resources. """ pass # Decorator generates OpenAPI spec @create_api_doc def documented_view(request): """ --- get: summary: Get a resource responses: 200: description: Success """ pass

Debug

Known issues

breakingPython 3.11 support dropped in v3.0.0. Only Python 3.12+ is supported.

fix

Upgrade to Python 3.12 or later, or pin to edx-api-doc-tools<3.0.0

affects: >=3.0.0

deprecatedThe 'fields' parameter in create_api_doc was deprecated in v2.x and removed in v3.0.0.

fix

Remove 'fields' argument; use docstring-based field descriptions instead.

affects: >=2.0.0,<3.0.0

gotchaDocstring format must be exactly YAML with '---' separator. Indentation errors cause silent failures or partial docs.

fix

Ensure docstring starts with a line containing only '---' and that YAML is properly indented.

affects: all

Upgrade

Version history

3.0.0latest on PyPI · released Mar 13, 2026

Audit

Dependencies

No dependency data recorded yet.

Agent activity

10 hits · last 30 days

node

Resources

githubhttps://github.com/openedx/api-doc-tools ↗

packagehttps://pypi.org/project/edx-api-doc-tools/ ↗

homepagehttps://edx.org ↗