Installation
Install the Package
pip install django-cfgOr with optional dependency groups:
pip install "django-cfg[grpc]" # gRPC support
pip install "django-cfg[full]" # All enterprise featuresOptional Dependency Groups
| Group | What it adds |
|---|---|
grpc | gRPC server support (grpcio, grpcio-tools) |
centrifugo | Real-time messaging (cent) |
rq | Redis Queue tasks (rq, django-rq) |
ai | Pydantic AI agents |
geo | Geographic/PostGIS support |
full | All enterprise features |
Start with the base install. You can add optional groups later as your project grows.
Requirements
| Tool | Version | Note |
|---|---|---|
| Python | 3.12+ | Required |
| Django | 5.0+ | Installed automatically with django-cfg |
| Node.js | 20+ | For frontend (pnpm will be needed) |
| Docker | Latest | Optional — for local services (Redis, PostgreSQL, Centrifugo) |
Create a Project
django-cfg create-project myproject
cd myprojectThis generates a project structure with Pydantic v2 configuration, auto-discovered extensions, and sensible defaults.
Verify Installation
django-cfg --version
django-cfg infoRun the Development Server
With Poetry
cd myproject
# Install Python dependencies
poetry install
# Run migrations
poetry run python manage.py migrate
# Start the server
poetry run python manage.py runserver
# Visit http://localhost:8000Troubleshooting
Python Version
# macOS
brew install [email protected]
# Ubuntu/Debian
sudo add-apt-repository ppa:deadsnakes/ppa
sudo apt install python3.12 python3.12-venv
# Windows
winget install Python.Python.3.12Support the Project
Star and Fork the repository on GitHub: github.com/markolofsen/django-cfg
Next Steps
- First Project - Build your first Django-CFG app
- Configuration - Learn about settings and environment
- Sample Project - Explore a production example
Last updated on
Django-CFG