djx-cli 0.1.0

Convention over configuration for Django - Rails-like scaffolding and generators

djx

Convention over configuration for Django. Rails-like scaffolding and generators.

Installation

pip install -e .

Quick Start

# Create new project (venv, Django, git - all automatic)
djx new myproject
cd myproject
source venv/bin/activate

# Generate full CRUD
djx scaffold Post title:string content:text published:boolean

# Run migrations
python manage.py makemigrations && python manage.py migrate

# Start server
python manage.py runserver

Visit: http://127.0.0.1:8000/posts/

Commands

Project Management

djx new myproject              # Create new Django project with venv, git
djx routes                     # Display all URL routes

Generators

djx scaffold Post title:string body:text published:boolean
djx scaffold Comment post:references author:string content:text
djx model User email:email name:string age:integer
djx controller Post
djx migration add_index_to_posts

Destroy

djx destroy scaffold Post      # Remove app, URLs, settings entry
djx destroy model Post         # Remove model only
djx destroy controller Post    # Remove views/templates only

Configuration

djx config DEBUG False
djx config ALLOWED_HOSTS '["localhost", "127.0.0.1"]'
djx add django-crispy-forms    # Install + add to INSTALLED_APPS

Field Types

• string → CharField
• text → TextField
• integer → IntegerField
• boolean → BooleanField
• date → DateField
• datetime → DateTimeField
• decimal → DecimalField
• email → EmailField
• url → URLField
• references:Model → ForeignKey

Example Workflow

# Create project
django-admin startproject myproject
cd myproject

# Generate scaffold
djx scaffold Article title:string content:text published:boolean

# Run migrations
python manage.py makemigrations
python manage.py migrate

# Start server
python manage.py runserver

Visit: http://localhost:8000/articles/

Architecture

Trade-offs:

• ✓ Faster development, less boilerplate
• ✓ Consistent structure across projects
• ✗ Less explicit than pure Django
• ✗ Opinionated URL patterns

Conventions:

• Auto-creates app if missing (pluralized model name)
• Auto-wires URLs to project
• Auto-adds apps to INSTALLED_APPS
• CRUD views use class-based views
• Templates follow app/model_action.html pattern