Skip to content

CodexDLC/codex-django-cli

Repository files navigation

codex-django-cli

PyPI Python License Documentation

CLI scaffolding package for codex-django projects. It provides the interactive codex-django command, project blueprints, and bootstrap workflows used to assemble Codex Django applications.


Install

# CLI only
pip install codex-django-cli

# Recommended end-user install via the runtime package
pip install "codex-django[cli]"

Requires Python 3.12 or newer.

Development

uv sync --extra dev
uv run pytest tests/unit/cli tests/integration/cli
uv build --no-sources

Install-chain e2e smoke:

# Local dev chain (editable codex-django-cli + editable ../codex-django)
uv run pytest tests/e2e/cli/test_install_chains_e2e.py -m e2e -k local_dev_chain -v

# Optional override for runtime checkout path
export CODEX_DJANGO_CHECKOUT=/absolute/path/to/codex-django

# Online-install chain (PyPI codex-django-cli + local codex-django wheel)
export CODEX_DJANGO_E2E_ONLINE=1
export CODEX_DJANGO_WHEEL=/absolute/path/to/codex_django-*.whl
uv run pytest tests/e2e/cli/test_install_chains_e2e.py -m e2e -k online_install_chain -v

# Optional: test a specific PyPI target (version, index alias, etc.)
export CODEX_DJANGO_CLI_PYPI_SPEC='codex-django-cli'

Requires Python 3.12 or newer.

Quick Start

# Create a new project
codex-django init myproject

# Or install through codex-django and use the same CLI entrypoint
pip install "codex-django[cli]"
codex-django init myproject --i18n --languages en,ru

Modules

Module Extra Description
codex_django_cli.main - Interactive entrypoint, menu flow, and legacy command dispatch.
codex_django_cli.engine - Blueprint renderer and file generation engine for scaffold assets.
codex_django_cli.commands - Init, app scaffolding, deploy helpers, quality tools, and notifications bootstrap.
codex_django_cli.blueprints - Packaged project, feature, deployment, and repository templates used by the CLI.

Documentation

Full docs with project structure, scaffold workflow, architecture, and API reference:

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

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).

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors