djinitx 0.3.2__tar.gz → 0.3.6__tar.gz

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

@@ -16,7 +16,7 @@ jobs:
         python-version: ["3.13"]
 
     steps:
-    - uses: actions/checkout@v6
+    - uses: actions/checkout@v7
 
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v6
@@ -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.2 → djinitx-0.3.6}/.github/workflows/codeql.yml

@@ -19,7 +19,7 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v6
+      uses: actions/checkout@v7
 
     - name: Initialize CodeQL
       uses: github/codeql-action/init@v4

djinitx-0.3.6/.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: squash

{djinitx-0.3.2 → djinitx-0.3.6}/.github/workflows/pre-commit.yml

@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v6
+    - uses: actions/checkout@v7
 
     - name: Set up Python
       uses: actions/setup-python@v6

{djinitx-0.3.2 → djinitx-0.3.6}/.github/workflows/publish.yml

@@ -11,7 +11,7 @@ jobs:
     permissions:
       id-token: write # IMPORTANT: this permission is mandatory for trusted publishing
     steps:
-    - uses: actions/checkout@v6
+    - uses: actions/checkout@v7
     - name: Set up Python
       uses: actions/setup-python@v6
       with:

{djinitx-0.3.2 → djinitx-0.3.6}/.gitignore

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

djinitx-0.3.6/PKG-INFO

@@ -0,0 +1,252 @@
+Metadata-Version: 2.4
+Name: djinitx
+Version: 0.3.6
+Summary: A CLI tool to setup Django project
+Project-URL: Homepage, https://github.com/S4NKALP/djinit
+Author-email: Sankalp Tharu <sankalptharu50028@gmail.com>
+License: MIT
+License-File: LICENSE
+Keywords: cli,dj,django,django project,django starter,django-init,djinit,djinitx,project
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 4.2
+Classifier: Framework :: Django :: 5.1
+Classifier: Framework :: Django :: 5.2
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Internet :: WWW/HTTP
+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: questionary>=2.0.1
+Requires-Dist: rich>=14.2.0
+Requires-Dist: typer>=0.21.1
+Description-Content-Type: text/markdown
+
+# djinit
+
+> PyPI didn't allow the original name, so you'll find it as **djinitx** on PyPI
+
+<div align="center">
+
+<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-5.1%20%7C%205.2%20%7C%206.0-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>
+
+A CLI that scaffolds production-ready Django projects with DRF, JWT auth, API docs, and deployment configs - all through an interactive wizard. No more copy-pasting settings or wiring up apps by hand.
+
+```bash
+pipx install djinitx
+djinit setup
+```
+
+## Installation
+
+```bash
+# Recommended - isolated environment
+pipx install djinitx
+
+# Or with uv
+uv tool install djinitx
+
+# Or with pip
+pip install djinitx
+```
+
+Requires Python 3.13+.
+
+## Usage
+
+### Create a project
+
+```bash
+djinit setup
+# or
+dj setup
+```
+
+The wizard walks you through these choices:
+
+1. **Project structure** - Standard, Predefined (`apps/` + `api/`), Unified (`core/` + `apps/`), or Single Folder
+2. **Project name and directory**
+3. **Database** - PostgreSQL or MySQL; `DATABASE_URL` or individual env vars
+4. **Frontend tools** - Tailwind CSS, HTMX, and/or Vite (optional)
+5. **Django apps** - Name them; optionally nest under an `apps/` package
+6. **CI/CD** - GitHub Actions, GitLab CI, both, or none
+
+When you're done, you have a fully configured Django project ready to run.
+
+### Add apps later
+
+```bash
+djinit app users products orders
+```
+
+Creates the apps, registers them in `INSTALLED_APPS`, and wires up URL includes.
+
+### Generate secret keys
+
+```bash
+djinit secret
+djinit secret --count 5 --length 64
+```
+
+## What You Get
+
+Every project ships with:
+
+- **Split settings** - `base.py`, `development.py`, `production.py` with sensible defaults
+- **Django REST Framework** - With JWT authentication (access + refresh tokens)
+- **API documentation** - Swagger UI at `/docs/`, ReDoc at `/schema/`
+- **CORS** - Configured for local dev, locked down for production
+- **WhiteNoise** - Static file serving, production-ready
+- **django-jazzmin** - Modern admin interface
+- **Environment management** - `.env.sample` with `django-environ`
+- **Deployment configs** - `Dockerfile`, `Procfile`, `runtime.txt`
+- **CI/CD pipelines** - GitHub Actions and/or GitLab CI
+- **Task runner** - `Justfile` with common commands
+- **`.gitignore`** - Python + Node defaults
+
+Optional add-ons when selected:
+
+| Feature | Package | What's configured |
+|---|---|---|
+| Tailwind CSS | django-tailwind-cli | Settings, DaisyUI theme, Node install in Docker |
+| HTMX | django-htmx | Installed app + HtmxMiddleware |
+| Vite | django-vite | `vite.config.ts`, dev/prod mode toggles, CI build step |
+
+### Development workflow
+
+```bash
+just dev              # Start dev server
+just migrate          # Run migrations
+just test             # Run tests
+just lint             # Lint with ruff
+just format           # Format with ruff
+just vite             # Start Vite dev server (if selected)
+just dev-full         # Django + Vite together (if selected)
+```
+
+No `just` installed? These map directly to Django management commands.
+
+## Project Structures
+
+### Standard
+
+```
+myproject/
+├── manage.py
+├── myproject/          # Config module
+│   ├── settings/       # base.py, development.py, production.py
+│   ├── urls.py
+│   └── wsgi.py
+└── apps/               # Your apps (optional)
+    └── users/
+```
+
+### Predefined
+
+```
+myproject/
+├── manage.py
+├── config/             # Django config
+│   ├── settings/
+│   └── urls.py
+├── apps/               # Business logic
+│   ├── users/
+│   └── core/
+└── api/                # API routes
+    └── v1/
+```
+
+### Unified
+
+```
+myproject/
+├── manage.py
+├── core/               # Django config
+│   ├── settings/
+│   └── urls.py
+└── apps/               # Main application package
+    ├── admin/
+    ├── models/
+    ├── serializers/
+    ├── views/
+    ├── urls/
+    └── api/
+```
+
+### Single Folder
+
+```
+myproject/
+├── manage.py
+├── project/            # Configurable name
+│   ├── settings/
+│   ├── urls.py
+│   ├── models/
+│   ├── api/
+│   └── wsgi.py
+```
+
+## Environment Setup
+
+```bash
+cp .env.sample .env
+```
+
+SQLite works out of the box for development. Swap in your production database when you're ready.
+
+## Packages
+
+| Package | Role |
+|---|---|
+| Django | Web framework |
+| django-environ | Environment variable management |
+| django-jazzmin | Admin UI |
+| djangorestframework | REST API toolkit |
+| djangorestframework-simplejwt | JWT authentication |
+| drf-yasg | Swagger/OpenAPI docs |
+| django-cors-headers | CORS handling |
+| whitenoise | Static file serving |
+| gunicorn | Production WSGI server |
+| psycopg[binary] | PostgreSQL driver |
+| django-tailwind-cli | Tailwind CSS _(optional)_ |
+| django-htmx | HTMX _(optional)_ |
+| django-vite | Vite bundler _(optional)_ |
+
+## API Endpoints
+
+| Endpoint | Description |
+|---|---|
+| `/admin/` | Django admin |
+| `/token/` | Obtain JWT pair |
+| `/token/refresh/` | Refresh access token |
+| `/docs/` | Swagger UI |
+| `/schema/` | ReDoc |
+
+## Contributing
+
+Contributions are welcome. Open an issue or submit a PR.
+
+1. Fork the repo
+2. Create a feature branch (`git checkout -b feature/whatever`)
+3. Make your changes and run `just test`
+4. Submit a pull request
+
+Match the existing code style - ruff linting and formatting are enforced.
+
+## License
+
+MIT © [Sankalp Tharu](https://sankalptharu.com.np)

djinitx-0.3.6/README.md

@@ -0,0 +1,219 @@
+# djinit
+
+> PyPI didn't allow the original name, so you'll find it as **djinitx** on PyPI
+
+<div align="center">
+
+<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-5.1%20%7C%205.2%20%7C%206.0-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>
+
+A CLI that scaffolds production-ready Django projects with DRF, JWT auth, API docs, and deployment configs - all through an interactive wizard. No more copy-pasting settings or wiring up apps by hand.
+
+```bash
+pipx install djinitx
+djinit setup
+```
+
+## Installation
+
+```bash
+# Recommended - isolated environment
+pipx install djinitx
+
+# Or with uv
+uv tool install djinitx
+
+# Or with pip
+pip install djinitx
+```
+
+Requires Python 3.13+.
+
+## Usage
+
+### Create a project
+
+```bash
+djinit setup
+# or
+dj setup
+```
+
+The wizard walks you through these choices:
+
+1. **Project structure** - Standard, Predefined (`apps/` + `api/`), Unified (`core/` + `apps/`), or Single Folder
+2. **Project name and directory**
+3. **Database** - PostgreSQL or MySQL; `DATABASE_URL` or individual env vars
+4. **Frontend tools** - Tailwind CSS, HTMX, and/or Vite (optional)
+5. **Django apps** - Name them; optionally nest under an `apps/` package
+6. **CI/CD** - GitHub Actions, GitLab CI, both, or none
+
+When you're done, you have a fully configured Django project ready to run.
+
+### Add apps later
+
+```bash
+djinit app users products orders
+```
+
+Creates the apps, registers them in `INSTALLED_APPS`, and wires up URL includes.
+
+### Generate secret keys
+
+```bash
+djinit secret
+djinit secret --count 5 --length 64
+```
+
+## What You Get
+
+Every project ships with:
+
+- **Split settings** - `base.py`, `development.py`, `production.py` with sensible defaults
+- **Django REST Framework** - With JWT authentication (access + refresh tokens)
+- **API documentation** - Swagger UI at `/docs/`, ReDoc at `/schema/`
+- **CORS** - Configured for local dev, locked down for production
+- **WhiteNoise** - Static file serving, production-ready
+- **django-jazzmin** - Modern admin interface
+- **Environment management** - `.env.sample` with `django-environ`
+- **Deployment configs** - `Dockerfile`, `Procfile`, `runtime.txt`
+- **CI/CD pipelines** - GitHub Actions and/or GitLab CI
+- **Task runner** - `Justfile` with common commands
+- **`.gitignore`** - Python + Node defaults
+
+Optional add-ons when selected:
+
+| Feature | Package | What's configured |
+|---|---|---|
+| Tailwind CSS | django-tailwind-cli | Settings, DaisyUI theme, Node install in Docker |
+| HTMX | django-htmx | Installed app + HtmxMiddleware |
+| Vite | django-vite | `vite.config.ts`, dev/prod mode toggles, CI build step |
+
+### Development workflow
+
+```bash
+just dev              # Start dev server
+just migrate          # Run migrations
+just test             # Run tests
+just lint             # Lint with ruff
+just format           # Format with ruff
+just vite             # Start Vite dev server (if selected)
+just dev-full         # Django + Vite together (if selected)
+```
+
+No `just` installed? These map directly to Django management commands.
+
+## Project Structures
+
+### Standard
+
+```
+myproject/
+├── manage.py
+├── myproject/          # Config module
+│   ├── settings/       # base.py, development.py, production.py
+│   ├── urls.py
+│   └── wsgi.py
+└── apps/               # Your apps (optional)
+    └── users/
+```
+
+### Predefined
+
+```
+myproject/
+├── manage.py
+├── config/             # Django config
+│   ├── settings/
+│   └── urls.py
+├── apps/               # Business logic
+│   ├── users/
+│   └── core/
+└── api/                # API routes
+    └── v1/
+```
+
+### Unified
+
+```
+myproject/
+├── manage.py
+├── core/               # Django config
+│   ├── settings/
+│   └── urls.py
+└── apps/               # Main application package
+    ├── admin/
+    ├── models/
+    ├── serializers/
+    ├── views/
+    ├── urls/
+    └── api/
+```
+
+### Single Folder
+
+```
+myproject/
+├── manage.py
+├── project/            # Configurable name
+│   ├── settings/
+│   ├── urls.py
+│   ├── models/
+│   ├── api/
+│   └── wsgi.py
+```
+
+## Environment Setup
+
+```bash
+cp .env.sample .env
+```
+
+SQLite works out of the box for development. Swap in your production database when you're ready.
+
+## Packages
+
+| Package | Role |
+|---|---|
+| Django | Web framework |
+| django-environ | Environment variable management |
+| django-jazzmin | Admin UI |
+| djangorestframework | REST API toolkit |
+| djangorestframework-simplejwt | JWT authentication |
+| drf-yasg | Swagger/OpenAPI docs |
+| django-cors-headers | CORS handling |
+| whitenoise | Static file serving |
+| gunicorn | Production WSGI server |
+| psycopg[binary] | PostgreSQL driver |
+| django-tailwind-cli | Tailwind CSS _(optional)_ |
+| django-htmx | HTMX _(optional)_ |
+| django-vite | Vite bundler _(optional)_ |
+
+## API Endpoints
+
+| Endpoint | Description |
+|---|---|
+| `/admin/` | Django admin |
+| `/token/` | Obtain JWT pair |
+| `/token/refresh/` | Refresh access token |
+| `/docs/` | Swagger UI |
+| `/schema/` | ReDoc |
+
+## Contributing
+
+Contributions are welcome. Open an issue or submit a PR.
+
+1. Fork the repo
+2. Create a feature branch (`git checkout -b feature/whatever`)
+3. Make your changes and run `just test`
+4. Submit a pull request
+
+Match the existing code style - ruff linting and formatting are enforced.
+
+## License
+
+MIT © [Sankalp Tharu](https://sankalptharu.com.np)

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

@@ -2,8 +2,8 @@
 
 ## Features
 
-- [ ] Docker Support: Auto generating `Dockerfile` so you can containerize easily
-- [ ] Frontend Integration: Options to scaffold React, Vue, or HTMX right alongside Django
+- [x] Docker Support: Auto generating `Dockerfile` so you can containerize easily
+- [x] Frontend Integration: Options to scaffold React, Vue, or HTMX right alongside Django
 - [ ] Celery: Making background tasks easier to set up
 - [ ] More Packages: Integrating other popular packages to help you build feature rich apps effortlessly
 
@@ -11,5 +11,5 @@
 
 - [ ] Add more project structure templates
 - [x] Add interactive configuration wizard
-- [ ] Add testing framework setup (pytest, coverage)
+- [x] Add testing framework setup (pytest, coverage)
 - [x] Improve structure detection

{djinitx-0.3.2 → djinitx-0.3.6}/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.6"
 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.6/requirements.txt

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

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

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

{djinitx-0.3.2 → djinitx-0.3.6}/setup.py

@@ -2,26 +2,25 @@ from setuptools import find_packages, setup
 
 setup(
     name="djinitx",
-    version="0.3.2",
+    version="0.3.6",
     description="A CLI tool to setup Django projects",
     long_description=open("README.md").read(),
     long_description_content_type="text/markdown",
     author="Sankalp Tharu",
     author_email="sankalptharu50028@gmail.com",
     url="https://github.com/S4NKALP/djinit",
-    packages=find_packages(include=["djinit", "djinit.*"]),
+    packages=find_packages(where="src"),
+    package_dir={"": "src"},
     include_package_data=True,
     install_requires=[
-        "ruff>=0.14.2",
-        "click>=8.3.0",
         "rich>=14.2.0",
-        "jinja2>=3.1.0",
         "questionary>=2.0.1",
+        "typer>=0.21.1",
     ],
     entry_points={
         "console_scripts": [
-            "djinit=djinit.generator:main",
-            "dj=djinit.generator:main",
+            "djinit=djinit.cli:app",
+            "dj=djinit.cli:app",
         ]
     },
     classifiers=[
@@ -55,7 +54,7 @@ setup(
         "django project",
         "django starter",
     ],
-    python_requires=">=3.13",
+    python_requires=">=3.10",
     project_urls={
         "Bug Reports": "https://github.com/S4NKALP/djinit/issues",
         "Source": "https://github.com/S4NKALP/djinit",