django-facile 1.0.0

A CLI tool to simplify Django development

🚀 Django Facile

Django Facile is a powerful CLI tool that simplifies Django development by automating project setup, environment management, and common workflows.

---

✨ Features

• ⚡ One-command project setup
• 🔄 Dev ↔ Prod environment switching
• 🛠 Built-in commands for migrations, shell, server
• 🔐 Production-ready configuration helpers
• 📦 Simplified Django workflow

---

📦 Installation

pip install django-facile

---

🚀 Quick Start

django-facile startproject myproject --env dev --db sqlite
cd myproject
django-facile run

---

📚 Commands Overview

Command	Description
startproject	Create a Django project
startapp	Create a Django app
switch-env	Switch environment (dev/prod)
run	Start development server
migrate	Run makemigrations + migrate
superuser	Create admin user
shell	Open Django shell
check	Validate project configuration
collectstatic	Prepare static files for production
--help	Show CLI help
--version	Show CLI version

---

🧠 Environment Modes

🧪 Development Mode (dev)

• Uses SQLite
• DEBUG = True
• Auto static serving
• Faster development

🚀 Production Mode (prod)

• Uses PostgreSQL
• DEBUG = False
• Requires collectstatic
• Security settings enabled

---

⚙️ Commands (Detailed)

---

🏗 Create Project

django-facile startproject <project_name> --env dev --db sqlite

Example:

django-facile startproject myproject --env dev --db sqlite

---

📦 Create App

django-facile startapp <app_name>

Example:

django-facile startapp blog

---

🔄 Switch Environment

Switch to Development:

django-facile switch-env dev

Switch to Production:

django-facile switch-env prod

---

▶️ Run Server

django-facile run

Custom port:

django-facile run --port 8001

---

🗄 Database Migrations

django-facile migrate

👉 Internally runs:

• makemigrations
• migrate

---

👤 Create Superuser

django-facile superuser

---

🐚 Django Shell

django-facile shell

---

🔍 Check Configuration

Normal check:

django-facile check

Production check:

django-facile check --deploy

---

📦 Collect Static Files (Production Only)

django-facile collectstatic

⚠️ Use only in production mode

---

📖 Help

django-facile --help

---

🔢 Version

django-facile --version

---

🔄 Typical Workflow

🧪 Development Workflow

django-facile startproject myproject --env dev --db sqlite
cd myproject
django-facile startapp blog
django-facile run

---

🚀 Production Workflow

django-facile switch-env prod
django-facile migrate
django-facile collectstatic
django-facile check --deploy

---

⚠️ Important Notes

• collectstatic is only required in production
• check --deploy should be run before deployment
• .env controls active environment
• Dev and Prod configs are separated internally

---

🧠 Why Django Facile?

Django setup and environment management can be repetitive and error-prone. Django Facile simplifies the workflow into a clean, developer-friendly CLI.

---

🤝 Contributing

Contributions are welcome! Feel free to open issues or submit pull requests.

---

📄 License

MIT License