Skip to main content

Standalone CLI and blueprint scaffolding package for codex-django

Project description

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 — DTOs, settings, logging, and shared developer tooling.
codex-platform Infrastructure — Redis, streams, workers, notifications, and runtime platform services.
codex-services Business logic — reusable booking and service-layer engines.
codex-django Django runtime layer — reusable apps, mixins, i18n, SEO, and framework integrations.
codex-django-cli Project assembly layer — CLI scaffolding, blueprints, and bootstrap workflows for Codex Django projects.

Each library is fully standalone where appropriate. Together, codex-django and codex-django-cli provide the runtime layer and project assembly workflow for Codex-based Django applications.

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_cli-0.2.2.tar.gz (118.3 kB view details)

Uploaded Source

Built Distribution

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

codex_django_cli-0.2.2-py3-none-any.whl (157.1 kB view details)

Uploaded Python 3

File details

Details for the file codex_django_cli-0.2.2.tar.gz.

File metadata

  • Download URL: codex_django_cli-0.2.2.tar.gz
  • Upload date:
  • Size: 118.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for codex_django_cli-0.2.2.tar.gz
Algorithm Hash digest
SHA256 e9d7bd03c3cc19ceda45253bab3c40057c0a81a39132bdc4eda587756f239967
MD5 aa23a8c0acf225f04fa330e5172879ff
BLAKE2b-256 0aa207cd8e8c2ef78926071bce2fc39c4c869ef7a2522fbe43c90bb1d950d350

See more details on using hashes here.

Provenance

The following attestation bundles were made for codex_django_cli-0.2.2.tar.gz:

Publisher: publish.yml on CodexDLC/codex-django-cli

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_cli-0.2.2-py3-none-any.whl.

File metadata

File hashes

Hashes for codex_django_cli-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 30e94d53ea0e9ceeda9d39361bc223117b53961cf736d97813e38f57f148506e
MD5 354d512619a7aa5c80ab01c2a752a7da
BLAKE2b-256 d1c6f3aff724beafa45a9480e57e5579ccc6df1a7e842c329c6e6d55c5a8e94f

See more details on using hashes here.

Provenance

The following attestation bundles were made for codex_django_cli-0.2.2-py3-none-any.whl:

Publisher: publish.yml on CodexDLC/codex-django-cli

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