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.3.tar.gz (118.1 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.3-py3-none-any.whl (157.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: codex_django_cli-0.2.3.tar.gz
  • Upload date:
  • Size: 118.1 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.3.tar.gz
Algorithm Hash digest
SHA256 2383d7b95e59bbbf0f2b8ae512523f218d3ffa51c8534201c3f0664a996c596c
MD5 509f0a08852c3e7a460c44564fed6267
BLAKE2b-256 fdeea6d824f0f2b532f45979a94af113cfced39af0fdc70a9368c11e8383059c

See more details on using hashes here.

Provenance

The following attestation bundles were made for codex_django_cli-0.2.3.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.3-py3-none-any.whl.

File metadata

File hashes

Hashes for codex_django_cli-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 dd143e1ab6377ac0bacbb24a23428681db3e9b839c4ed37f820344a2c8aab78d
MD5 9924d4ae7a157731348b6a70db935ee3
BLAKE2b-256 8a176f08c84dcb15cd2cb6e74f0cda812ebf3d7b1b4748a42db28fd0584386d3

See more details on using hashes here.

Provenance

The following attestation bundles were made for codex_django_cli-0.2.3-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