Skip to main content

Django runtime utilities, mixins, adapters, and reusable modules for Codex projects

Project description

codex-django

PyPI Python CI License Documentation

Django runtime integration layer for the Codex ecosystem: reusable modules, cabinet UI building blocks, and shared adapters for Codex-shaped Django projects. Project scaffolding now lives in the companion package codex-django-cli, while this repository focuses on installable runtime code.


Install

# Runtime library only
pip install codex-django

# Runtime + companion CLI package
pip install "codex-django[cli]"

# Runtime + CLI + day-to-day development toolchain
pip install "codex-django[dev]"

Requires Python 3.12 or newer.

Project Scaffolding

The codex-django runtime package no longer owns the CLI implementation. Use the companion package when you want to scaffold or extend a project:

pip install "codex-django[cli]"
# or: pip install codex-django-cli
codex-django init myproject
codex-django add-client-cabinet --project myproject

Temporary compatibility shims remain under codex_django.cli, but the real CLI code lives in codex-django-cli.

Development

uv sync --extra dev
uv run pytest
uv run mypy src/
uv run pre-commit run --all-files
uv build --no-sources

Quick Start

Runtime Example

from datetime import date

from codex_django.booking import DjangoAvailabilityAdapter
from codex_django.booking.selectors import get_available_slots

adapter = DjangoAvailabilityAdapter(
    resource_model=Master,
    appointment_model=Appointment,
    service_model=Service,
    working_day_model=MasterWorkingDay,
    day_off_model=MasterDayOff,
    booking_settings_model=BookingSettings,
    timezone="UTC",
)

result = get_available_slots(
    adapter=adapter,
    service_ids=[1],
    target_date=date.today(),
)

print(result.get_unique_start_times())

What Each Optional Module Adds

  • cabinet: user-facing dashboard pages, profile/settings views, and cabinet adapters.
  • booking: booking app scaffolds, booking settings, cabinet booking pages, and booking templates.
  • notifications: notification content models, service hooks, and ARQ client scaffolding.

Modules

Module Extra Description
codex_django.core - Shared Django infrastructure: mixins, SEO access path, i18n helpers, sitemap base, Redis managers.
codex_django.system - Project-state models and admin workflows: site settings, static content, integrations, fixture orchestration.
codex_django.notifications - Django notification orchestration: content selector, payload builder, queue/direct adapters.
codex_django.booking - Django adapter layer over codex-services booking engine: model mixins, availability adapter, booking selectors.
codex_django.cabinet - Reusable cabinet/dashboard framework with registry-based navigation, widgets, and cached settings.
codex_django.cli compat only Temporary forwarding layer to codex-django-cli; not part of the long-term runtime surface.
codex_django.showcase - DEBUG-only showcase layer for demo screens and generated-project previews backed by mock data.

Documentation

Full docs with architecture, API reference, and generated project structure:

https://codexdlc.github.io/codex-django/

Part of the Codex ecosystem

Package Role
codex-core Foundation — immutable DTOs, PII masking, env settings
codex-platform Infrastructure — Redis, Streams, ARQ workers, Notifications
codex-ai LLM layer — unified async interface for OpenAI, Gemini, Anthropic
codex-services Business logic — Booking engine, CRM, Calendar

Each library is fully standalone — install only what your project needs. Together they form the backbone of codex-bot (Telegram AI-agent infrastructure built on aiogram) and codex-django (Django integration layer and scaffolding toolkit).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

codex_django-0.5.2.tar.gz (1.4 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

codex_django-0.5.2-py3-none-any.whl (1.3 MB view details)

Uploaded Python 3

File details

Details for the file codex_django-0.5.2.tar.gz.

File metadata

  • Download URL: codex_django-0.5.2.tar.gz
  • Upload date:
  • Size: 1.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for codex_django-0.5.2.tar.gz
Algorithm Hash digest
SHA256 d9cbb915e2fca98ac5d1c8b1a0a9bbbc146a5e1e73060d53ac24aa89c478aa85
MD5 93267bf305a12e4901cd54946c7470cb
BLAKE2b-256 38b603e881795a6354a199055b68e5d99e46a2e5700519ea942ca1c6660fd204

See more details on using hashes here.

Provenance

The following attestation bundles were made for codex_django-0.5.2.tar.gz:

Publisher: publish.yml on CodexDLC/codex-django

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file codex_django-0.5.2-py3-none-any.whl.

File metadata

  • Download URL: codex_django-0.5.2-py3-none-any.whl
  • Upload date:
  • Size: 1.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for codex_django-0.5.2-py3-none-any.whl
Algorithm Hash digest
SHA256 2c69558406db9dbf918e6a75b2911fddcf006a3df9245421978934061dda5f82
MD5 7692df40f1de199ed7062b704f897852
BLAKE2b-256 77cc83ce5e40f2347d9ffffdfe81f6bf6d5458e5eaf85e6168ba6c4c7e1ebd0f

See more details on using hashes here.

Provenance

The following attestation bundles were made for codex_django-0.5.2-py3-none-any.whl:

Publisher: publish.yml on CodexDLC/codex-django

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page