edx-organizations

8.0.0 verified Fri May 01 auth: no python

Organization management module for Open edX. Handles creation, membership, and API endpoints for organizations. Current version 8.0.0, updated irregularly with monthly bot-driven dependency upgrades.

pip install edx-organizations

Common errors

error ModuleNotFoundError: No module named 'organizations.api' ↓

cause Import path changed: old 'api' module was renamed to 'api.v0' in v6.x.

fix

Use 'from organizations.api.v0 import views' instead.

error TypeError: __init__() got an unexpected keyword argument 'short_name' ↓

cause Using outdated constructor signature. short_name was added in v4.x.

fix

Ensure you are using a recent version (>=4.0) and check the model fields.

Warnings

breaking Dropped Python 3.8 in v7.0.0. Python 3.8 users must pin to v6.13.0 or older. ↓

fix Upgrade Python to 3.9+ or pin edx-organizations<7.0.0

breaking Removed Django 3.2 support in v6.13.0. Django 3.2 users must stay on v6.12.x. ↓

fix Upgrade to Django 4.2+ or pin edx-organizations<6.13.0

deprecated Direct use of Organization model outside of Open edX app is discouraged. Use API endpoints instead. ↓

fix Prefer REST API (v0) endpoints for CRUD operations.

gotcha Short names with periods (e.g., 'test.org') cause 404 errors in older versions. ↓

fix Upgrade to >=6.11.1 or avoid periods in short_name.

Imports

Organization

from organizations.models import Organization

Correct import for the main model.

Organization API views

wrong

from organizations.api import views

correct

from organizations.api.v0 import views

v0 module is versioned; older paths removed.

Quickstart

Create a simple organization record.

from organizations.models import Organization
from django.db import connection

org = Organization.objects.create(
    name='Test University',
    short_name='test_uni',
)
print(f'Created organization: {org.name}')