djinitx 0.3.2__tar.gz → 0.3.4__tar.gz

{djinitx-0.3.2 → djinitx-0.3.4}/.github/workflows/ci.yml

@@ -31,15 +31,15 @@ jobs:
 
     - name: Lint with Ruff
       run: |
-        ruff check djinit/
+        ruff check src/djinit/
 
     - name: Check formatting with Ruff
       run: |
-        ruff format --check djinit/
+        ruff format --check src/djinit/
 
     - name: Test CLI import
       run: |
-        python -c "from djinit.generator import main; print('Import successful')"
+        python -c "from djinit.cli import main; print('Import successful')"
 
     - name: Test console script entry point
       run: |

djinitx-0.3.4/.github/workflows/dependabot-auto-merge.yml

@@ -0,0 +1,22 @@
+name: Dependabot Auto-Merge
+
+on:
+  pull_request_target:
+    types: [opened, synchronize, reopened]
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  dependabot:
+    runs-on: ubuntu-latest
+    # Check that it's actually dependabot
+    if: github.event.pull_request.user.login == 'dependabot[bot]'
+    steps:
+      - name: Merge PR from Dependabot
+        uses: fastify/github-action-merge-dependabot@v3
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          use-github-auto-merge: true
+          target: minor

djinitx-0.3.2/djinit/templates/project/gitignore.j2 → djinitx-0.3.4/.gitignore

@@ -1,6 +1,7 @@
 #--------------------------------------------------#
 # The following was generated by djinit: #
 #--------------------------------------------------#
+AGENTS.md
 
 # Python
 *.py[cod]

{djinitx-0.3.2 → djinitx-0.3.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: djinitx
-Version: 0.3.2
+Version: 0.3.4
 Summary: A CLI tool to setup Django project
 Project-URL: Homepage, https://github.com/S4NKALP/djinit
 Author-email: Sankalp Tharu <sankalptharu50028@gmail.com>
@@ -26,9 +26,9 @@ Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
 Classifier: Topic :: Software Development :: Code Generators
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.10
-Requires-Dist: jinja2>=3.1.0
 Requires-Dist: questionary>=2.0.1
 Requires-Dist: rich>=14.2.0
+Requires-Dist: typer>=0.21.1
 Description-Content-Type: text/markdown
 
 # djinit
@@ -44,7 +44,7 @@ Description-Content-Type: text/markdown
 
 </div>
 
-**djinit** helps you set up a production-ready Django project in minutes. No more copy-pasting settings or manually wiring up apps, just answer a few questions and get a modern Django project with REST API, authentication, documentation, and deployment configs ready to go.
+**djinit** helps you set up a production‑ready Django project in minutes. No more copy‑pasting settings or manually wiring up apps—just answer a few questions and get a modern Django project with REST API, authentication, documentation, and deployment configs ready to go.
 
 ## Why djinit?
 
@@ -70,63 +70,51 @@ Or with uv:
 uv tool install djinitx
 ```
 
-**Requirements**: Python 3.13+
+**Requirements**: Python 3.13+
 
 ## Getting Started
 
-Just run:
-
 ```bash
 djinit setup
 ```
 
-You can also use the shorter alias:
+or the shorter alias:
 
 ```bash
 dj setup
 ```
 
-The tool will ask you a few questions:
+The wizard will ask you a few questions:
 
 1. **What structure do you want?**
-   - **Standard**: Classic Django layout with split settings
-   - **Predefined**: Organized with `apps/` and `api/` folders (great for larger projects)
-   - **Unified**: Everything under `core/` and `apps/` (clean and minimal)
-   - **Single Folder**: All apps in one configurable folder (simple and flat)
+   - **Standard** – Classic Django layout with split settings
+   - **Predefined** – Organized with `apps/` and `api/` folders (great for larger projects)
+   - **Unified** – Everything under `core/` and `apps/` (clean and minimal)
+   - **Single Folder** – All apps in one configurable folder (simple and flat)
 
-2. **Project Setup**:
-   - Where to create it (use `.` for current directory)
-   - Project name (or directory name for Single Folder)
+2. **Project Setup** – Destination directory (use `.` for current) and project name.
 
-3. **Database Configuration**:
-   - Use `DATABASE_URL` (cleaner, recommended)
-   - Or separate DB variables
-   - Choose between PostgreSQL or MySQL
+3. **Database Configuration** – Choose `DATABASE_URL` (recommended) or individual variables; pick PostgreSQL or MySQL.
 
-4. **Django Apps** (Standard Structure only):
-   - Whether to use an `apps/` folder
-   - Which apps to create
+4. **Django Apps** *(Standard structure only)* – Whether to create an `apps/` folder and which apps to scaffold.
 
-5. **CI/CD Pipeline**:
-   - GitHub Actions, GitLab CI, both, or skip it
+5. **CI/CD Pipeline** – GitHub Actions, GitLab CI, both, or skip it.
 
-That's it! Your project will be ready with everything configured.
+That’s it—your project will be ready with everything configured.
 
 ## What You Get
 
-Every project includes:
-
 - **Split settings** for development and production
 - **Django REST Framework** with JWT authentication
 - **API documentation** (Swagger UI at `/docs/`)
 - **CORS** configured for local development
-- **WhiteNoise** for serving static files
+- **WhiteNoise** for static files
 - **PostgreSQL** support (SQLite for dev)
-- **Modern admin** interface (django-jazzmin)
-- **Deployment ready** with Procfile and runtime.txt
-- **Development tools** (Justfile with common commands)
-- **Environment template** (.env.sample)
-- **Git ready** (.gitignore included)
+- **Modern admin** interface (`django-jazzmin`)
+- **Deployment ready** with `Procfile` and `runtime.txt`
+- **Development tools** (`Justfile` with common commands)
+- **Environment template** (`.env.sample`)
+- **Git ready** (`.gitignore` included)
 
 ## Commands
 
@@ -136,13 +124,13 @@ Every project includes:
 djinit setup
 ```
 
-### Add Apps to Existing Project
+### Add Apps to an Existing Project
 
 ```bash
 djinit app users products orders
 ```
 
-This automatically creates the apps, adds them to `INSTALLED_APPS`, and wires up URLs.
+Creates the apps, adds them to `INSTALLED_APPS`, and wires up URLs.
 
 ### Generate Secret Keys
 
@@ -150,14 +138,12 @@ This automatically creates the apps, adds them to `INSTALLED_APPS`, and wires up
 djinit secret
 ```
 
-Need more? Use `--count 5` or change length with `--length 64`.
+Use `--count 5` to generate five keys or `--length 64` to change the length.
 
 ## Project Structures
 
 ### Standard Structure
 
-The classic Django layout with split settings:
-
 ```
 myproject/
 ├── manage.py
@@ -171,8 +157,6 @@ myproject/
 
 ### Single Folder Layout
 
-Simple structure with all apps in one folder:
-
 ```
 myproject/
 ├── manage.py
@@ -180,7 +164,7 @@ myproject/
 │   ├── settings/
 │   ├── urls.py
 │   ├── models/         # All models here
-│   ├── api/            # API views and serializers
+│   ├── api/            # API views & serializers
 │   │   └── your_model_name/
 │   │       ├── views.py
 │   │       ├── serializers.py
@@ -190,8 +174,6 @@ myproject/
 
 ### Predefined Structure
 
-Organized for larger projects:
-
 ```
 myproject/
 ├── manage.py
@@ -207,8 +189,6 @@ myproject/
 
 ### Unified Structure
 
-Clean and minimal:
-
 ```
 myproject/
 ├── manage.py
@@ -226,7 +206,7 @@ myproject/
 
 ## Development Workflow
 
-Your project comes with a `Justfile` for common tasks:
+Your project ships with a `Justfile` for common tasks:
 
 ```bash
 just dev              # Start dev server
@@ -238,52 +218,90 @@ just format           # Format code
 just lint             # Lint code
 ```
 
-Don't have `just` installed? No problem—these are just shortcuts for standard Django commands.
+If you don’t have `just` installed, these are just shortcuts for the equivalent Django commands.
 
 ## What's Included
 
 ### Packages
 
-- Django (web framework)
-- Django REST Framework (API)
-- djangorestframework-simplejwt (JWT auth)
-- drf-spectacular (API docs)
-- django-cors-headers (CORS)
-- django-jazzmin (modern admin)
-- whitenoise (static files)
-- psycopg2-binary (PostgreSQL)
-- gunicorn (production server)
-- python-dotenv (environment variables)
+- **Django** – Web framework
+- **Django REST Framework** – API toolkit
+- **djangorestframework‑simplejwt** – JWT authentication
+- **drf‑spectacular** – OpenAPI/Swagger docs
+- **django‑cors‑headers** – CORS handling
+- **django‑jazzmin** – Modern admin UI
+- **whitenoise** – Static file serving
+- **psycopg2‑binary** – PostgreSQL driver
+- **gunicorn** – Production WSGI server
+- **python‑dotenv** – `.env` handling
 
 ### API Endpoints
 
-- `/admin/` - Django admin
-- `/token/` - Get JWT token
-- `/token/refresh/` - Refresh token
-- `/docs/` - Swagger UI (dev only)
-- `/schema/` - OpenAPI schema (dev only)
+| Endpoint          | Description                     |
+|-------------------|---------------------------------|
+| `/admin/`         | Django admin                    |
+| `/token/`         | Obtain JWT token                |
+| `/token/refresh/` | Refresh JWT token               |
+| `/docs/`          | Swagger UI (dev only)           |
+| `/schema/`        | OpenAPI schema (dev only)       |
 
-### Settings
+### Settings Overview
 
-**Development**: SQLite, debug mode, console emails, permissive CORS
-**Production**: PostgreSQL, security hardened, SMTP emails, strict CORS
+- **Development** – SQLite, `DEBUG=True`, console email backend, permissive CORS.
+- **Production** – PostgreSQL, hardened security settings, SMTP email backend, strict CORS.
 
 ## Environment Setup
 
-Copy `.env.sample` to `.env` and fill in your values:
+Copy the sample file and fill in your values:
 
 ```bash
-SECRET_KEY=your-secret-key-here  # Use: djinit secret
+cp .env.sample .env
+```
+
+```dotenv
+SECRET_KEY=your-secret-key-here  # Generate with: djinit secret
 DATABASE_URL=postgres://user:pass@host:5432/db
 ALLOWED_HOSTS=yourdomain.com,www.yourdomain.com
 ```
 
-For development, SQLite works out of the box—no database setup needed!
+SQLite works out of the box for development—no extra DB setup required.
+
+## Roadmap
+
+The following items are tracked in **TODO.md** and represent the near‑future direction of djinit.
+
+### Planned Features
+- **Docker Support** – Auto‑generate a `Dockerfile` for containerized deployments.
+- **Frontend Integration** – Scaffold React, Vue, or HTMX alongside the Django backend.
+- **Celery Integration** – Simplify background task setup with Celery.
+- **More Packages** – Add optional integrations for popular Django packages.
+
+### Enhancements
+- **Add more project structure templates** – Expand the set of ready‑made layouts.
+- **Add testing framework setup** – Provide pytest and coverage configuration out of the box.
+- **Fix bugs** – Ongoing maintenance and bug resolution.
+
+### Completed
+- **Interactive configuration wizard** – Streamlined project creation experience.
+- **Improved structure detection** – Smarter detection of existing Django layouts.
+
+> Contributions that address any of the above items are highly welcome!
 
 ## Contributing
 
 Found a bug or have an idea? Open an issue or submit a pull request. Contributions are always welcome!
 
+1. Fork the repository.
+2. Create a feature branch (`git checkout -b feature/awesome-feature`).
+3. Make your changes and ensure tests pass (`just test`).
+4. Submit a pull request with a clear description of the change.
+
+Please follow the existing code style (ruff + black) and include tests for new functionality.
+
 ## License
 
 MIT © Sankalp Tharu
+
+---
+
+*© 2024 Sankalp Tharu. All rights reserved.*

djinitx-0.3.4/README.md

@@ -0,0 +1,274 @@
+# djinit
+
+<div align="center">
+
+> PyPI didn't allow the original name, so you'll find it as **djinitx** on PyPI
+
+<img src="https://img.shields.io/pypi/v/djinitx?color=blue&label=PyPI&logo=pypi&logoColor=white" alt="PyPI">
+<img src="https://img.shields.io/badge/Django-4.2%20%7C%205.1%20%7C%205.2-0C4B33?logo=django&logoColor=white" alt="Django">
+<img src="https://img.shields.io/badge/Python-3.13%2B-3776AB?logo=python&logoColor=white" alt="Python">
+<a href="https://github.com/S4NKALP/djinit/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License"></a>
+
+</div>
+
+**djinit** helps you set up a production‑ready Django project in minutes. No more copy‑pasting settings or manually wiring up apps—just answer a few questions and get a modern Django project with REST API, authentication, documentation, and deployment configs ready to go.
+
+## Why djinit?
+
+Starting a Django project usually means spending hours setting up the same things: splitting settings for dev/prod, configuring DRF, adding JWT auth, setting up CORS, preparing for deployment. djinit does all of this for you with sensible defaults and lets you choose the project structure that fits your needs.
+
+## Installation
+
+**Recommended** (using pipx):
+
+```bash
+pipx install djinitx
+```
+
+Or with pip:
+
+```bash
+pip install djinitx
+```
+
+Or with uv:
+
+```bash
+uv tool install djinitx
+```
+
+**Requirements**: Python 3.13+
+
+## Getting Started
+
+```bash
+djinit setup
+```
+
+or the shorter alias:
+
+```bash
+dj setup
+```
+
+The wizard will ask you a few questions:
+
+1. **What structure do you want?**
+   - **Standard** – Classic Django layout with split settings
+   - **Predefined** – Organized with `apps/` and `api/` folders (great for larger projects)
+   - **Unified** – Everything under `core/` and `apps/` (clean and minimal)
+   - **Single Folder** – All apps in one configurable folder (simple and flat)
+
+2. **Project Setup** – Destination directory (use `.` for current) and project name.
+
+3. **Database Configuration** – Choose `DATABASE_URL` (recommended) or individual variables; pick PostgreSQL or MySQL.
+
+4. **Django Apps** *(Standard structure only)* – Whether to create an `apps/` folder and which apps to scaffold.
+
+5. **CI/CD Pipeline** – GitHub Actions, GitLab CI, both, or skip it.
+
+That’s it—your project will be ready with everything configured.
+
+## What You Get
+
+- **Split settings** for development and production
+- **Django REST Framework** with JWT authentication
+- **API documentation** (Swagger UI at `/docs/`)
+- **CORS** configured for local development
+- **WhiteNoise** for static files
+- **PostgreSQL** support (SQLite for dev)
+- **Modern admin** interface (`django-jazzmin`)
+- **Deployment ready** with `Procfile` and `runtime.txt`
+- **Development tools** (`Justfile` with common commands)
+- **Environment template** (`.env.sample`)
+- **Git ready** (`.gitignore` included)
+
+## Commands
+
+### Create a Project
+
+```bash
+djinit setup
+```
+
+### Add Apps to an Existing Project
+
+```bash
+djinit app users products orders
+```
+
+Creates the apps, adds them to `INSTALLED_APPS`, and wires up URLs.
+
+### Generate Secret Keys
+
+```bash
+djinit secret
+```
+
+Use `--count 5` to generate five keys or `--length 64` to change the length.
+
+## Project Structures
+
+### Standard Structure
+
+```
+myproject/
+├── manage.py
+├── myproject/          # Config module
+│   ├── settings/       # Split settings
+│   ├── urls.py
+│   └── wsgi.py
+└── apps/               # Your apps (optional)
+    └── users/
+```
+
+### Single Folder Layout
+
+```
+myproject/
+├── manage.py
+├── project/            # Configurable folder name
+│   ├── settings/
+│   ├── urls.py
+│   ├── models/         # All models here
+│   ├── api/            # API views & serializers
+│   │   └── your_model_name/
+│   │       ├── views.py
+│   │       ├── serializers.py
+│   │       └── urls.py
+│   └── wsgi.py
+```
+
+### Predefined Structure
+
+```
+myproject/
+├── manage.py
+├── config/             # Django config
+│   ├── settings/
+│   └── urls.py
+├── apps/               # Business logic
+│   ├── users/
+│   └── core/
+└── api/                # API routes
+    └── v1/
+```
+
+### Unified Structure
+
+```
+myproject/
+├── manage.py
+├── core/               # Django config
+│   ├── settings/
+│   └── urls.py
+└── apps/               # Main application package
+    ├── admin/
+    ├── models/
+    ├── serializers/
+    ├── views/
+    ├── urls/
+    └── api/            # API routes
+```
+
+## Development Workflow
+
+Your project ships with a `Justfile` for common tasks:
+
+```bash
+just dev              # Start dev server
+just migrate          # Run migrations
+just makemigrations   # Create migrations
+just shell            # Django shell
+just test             # Run tests
+just format           # Format code
+just lint             # Lint code
+```
+
+If you don’t have `just` installed, these are just shortcuts for the equivalent Django commands.
+
+## What's Included
+
+### Packages
+
+- **Django** – Web framework
+- **Django REST Framework** – API toolkit
+- **djangorestframework‑simplejwt** – JWT authentication
+- **drf‑spectacular** – OpenAPI/Swagger docs
+- **django‑cors‑headers** – CORS handling
+- **django‑jazzmin** – Modern admin UI
+- **whitenoise** – Static file serving
+- **psycopg2‑binary** – PostgreSQL driver
+- **gunicorn** – Production WSGI server
+- **python‑dotenv** – `.env` handling
+
+### API Endpoints
+
+| Endpoint          | Description                     |
+|-------------------|---------------------------------|
+| `/admin/`         | Django admin                    |
+| `/token/`         | Obtain JWT token                |
+| `/token/refresh/` | Refresh JWT token               |
+| `/docs/`          | Swagger UI (dev only)           |
+| `/schema/`        | OpenAPI schema (dev only)       |
+
+### Settings Overview
+
+- **Development** – SQLite, `DEBUG=True`, console email backend, permissive CORS.
+- **Production** – PostgreSQL, hardened security settings, SMTP email backend, strict CORS.
+
+## Environment Setup
+
+Copy the sample file and fill in your values:
+
+```bash
+cp .env.sample .env
+```
+
+```dotenv
+SECRET_KEY=your-secret-key-here  # Generate with: djinit secret
+DATABASE_URL=postgres://user:pass@host:5432/db
+ALLOWED_HOSTS=yourdomain.com,www.yourdomain.com
+```
+
+SQLite works out of the box for development—no extra DB setup required.
+
+## Roadmap
+
+The following items are tracked in **TODO.md** and represent the near‑future direction of djinit.
+
+### Planned Features
+- **Docker Support** – Auto‑generate a `Dockerfile` for containerized deployments.
+- **Frontend Integration** – Scaffold React, Vue, or HTMX alongside the Django backend.
+- **Celery Integration** – Simplify background task setup with Celery.
+- **More Packages** – Add optional integrations for popular Django packages.
+
+### Enhancements
+- **Add more project structure templates** – Expand the set of ready‑made layouts.
+- **Add testing framework setup** – Provide pytest and coverage configuration out of the box.
+- **Fix bugs** – Ongoing maintenance and bug resolution.
+
+### Completed
+- **Interactive configuration wizard** – Streamlined project creation experience.
+- **Improved structure detection** – Smarter detection of existing Django layouts.
+
+> Contributions that address any of the above items are highly welcome!
+
+## Contributing
+
+Found a bug or have an idea? Open an issue or submit a pull request. Contributions are always welcome!
+
+1. Fork the repository.
+2. Create a feature branch (`git checkout -b feature/awesome-feature`).
+3. Make your changes and ensure tests pass (`just test`).
+4. Submit a pull request with a clear description of the change.
+
+Please follow the existing code style (ruff + black) and include tests for new functionality.
+
+## License
+
+MIT © Sankalp Tharu
+
+---
+
+*© 2024 Sankalp Tharu. All rights reserved.*

{djinitx-0.3.2 → djinitx-0.3.4}/TODO.md

@@ -13,3 +13,4 @@
 - [x] Add interactive configuration wizard
 - [ ] Add testing framework setup (pytest, coverage)
 - [x] Improve structure detection
+- [ ] Fix bugs

{djinitx-0.3.2 → djinitx-0.3.4}/pyproject.toml

@@ -3,11 +3,11 @@ requires = ["hatchling"]
 build-backend = "hatchling.build"
 
 [tool.hatch.build.targets.wheel]
-packages = ["djinit"]
+packages = ["src/djinit"]
 
 [project]
 name = "djinitx"
-version = "0.3.2"
+version = "0.3.4"
 description = "A CLI tool to setup Django project"
 readme = "README.md"
 requires-python = ">=3.10"
@@ -48,16 +48,16 @@ classifiers=[
     ]
 dependencies = [
     "rich>=14.2.0",
-    "jinja2>=3.1.0",
     "questionary>=2.0.1",
+    "typer>=0.21.1",
 ]
 
 [project.urls]
 Homepage = "https://github.com/S4NKALP/djinit"
 
 [project.scripts]
-djinit = "djinit.generator:main"
-dj = "djinit.generator:main"
+djinit = "djinit.cli:app"
+dj = "djinit.cli:app"
 
 [dependency-groups]
 dev = [

djinitx-0.3.4/requirements.txt

@@ -0,0 +1,5 @@
+questionary==2.1.1
+rich==15.0.0
+# dev
+ruff==0.15.11
+pre-commit==4.5.1

{djinitx-0.3.2 → djinitx-0.3.4}/ruff.toml

@@ -2,6 +2,7 @@
 
 line-length = 120
 target-version = "py38"
+exclude = ["django-new"]
 
 [lint]
 select = [