djux

djux is a CLI and registry for adding production-ready Django app templates to a project in one command. It handles the repetitive setup work: app files, Django settings, URL wiring, pip dependencies, and migrations.

pip install djux

djux new myproject
cd myproject

djux add auth

Think of it as a Django app installer where the installed code is copied into your project so you can own it, edit it, and ship it like normal Django code.

Vision

Djux aims to make reusable Django app templates easier to discover, install, inspect, and customize. The project is intentionally open to community feedback: the registry should grow around apps Django developers actually want, with a safe update story for vendored app code.

Current focus:

• Core app templates such as auth, users, api-keys, and files.
• AI-ready templates such as ai-models, ai-prompts, ai-chat, ai-usage, and ai-rag.
• A safer update workflow for copied app code: djux outdated and djux update <app>.

See APP_ROADMAP.md for the full roadmap.

Installation

Requires Python 3.10+.

pip install djux

Verify:

djux --version

Quick start

# 1. Create a new project
djux new myproject
cd myproject

# 2. Set up your environment
python -m venv .venv
source .venv/bin/activate    # Windows: .venv\Scripts\activate
pip install -r requirements.txt
cp .env.example .env

# 3. Run initial migrations and start the server
python manage.py migrate
python manage.py runserver

# 4. Add apps
djux add auth

See docs/getting-started.md for a full walkthrough.

Available apps

djux list

How it works

djux add <app> currently:

1. Looks up the app in the registry.
2. Downloads and extracts the app zip from GitHub.
3. Validates the djux.json manifest.
4. Copies the app/ folder into your project's apps/ directory.
5. Patches config/settings.py with INSTALLED_APPS entries and settings blocks.
6. Patches config/urls.py with the route include.
7. Runs pip install for declared dependencies.
8. Runs python manage.py migrate if the app has migrations.
9. Records the installed app in djux.project.json.

Installed apps are vendored into the project. That means developers fully own the copied code after install.

Project layout

myproject/
|-- config/
|   |-- settings.py        # djux patches INSTALLED_APPS here
|   `-- urls.py            # djux adds URL includes here
|-- apps/                  # all Django apps land here
|-- templates/
|-- static/
|-- manage.py
|-- djux.project.json      # tracks installed apps
`-- requirements.txt

Documentation

Repositories

Contributing

Contributors and testers are welcome. Useful ways to help:

• Build official app templates.
• Test Djux in real Django projects.
• Improve the CLI and update workflow.
• Review app manifests and registry entries.
• Improve documentation.

Start with CONTRIBUTING.md, then check the roadmap and open issues.

License

MIT