djinitx 0.1.0__tar.gz

djinitx-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Sankalp Tharu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

djinitx-0.1.0/MANIFEST.in

@@ -0,0 +1,3 @@
+recursive-include djinit/templates *.j2
+include README.md
+include LICENSE

djinitx-0.1.0/PKG-INFO

@@ -0,0 +1,182 @@
+Metadata-Version: 2.4
+Name: djinitx
+Version: 0.1.0
+Summary: A CLI tool to setup Django project
+Home-page: https://github.com/S4NKALP/djinit
+Author: Sankalp Tharu
+Author-email: Sankalp Tharu <sankalptharu50028@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/S4NKALP/djinit
+Keywords: django,cli,project,djinit,djinitx,dj,django-init,django project,django starter
+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: 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: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: Code Generators
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=8.3.0
+Requires-Dist: rich>=14.2.0
+Requires-Dist: ruff>=0.14.2
+Requires-Dist: jinja2>=3.1.0
+Dynamic: author
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-python
+
+# djinit
+
+<p align="center">
+  <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>
+</p>
+
+A fast, interactive CLI to bootstrap a modern, production‑ready Django project in minutes — featuring split settings, DRF and JWT integration, OpenAPI docs, CORS, static file handling via WhiteNoise, Postgres‑friendly configuration, CI/CD templates, deployment helpers, and battle‑tested defaults that deliver a polished developer experience out of the box.
+
+- ✨ Split settings: `settings/base.py`, `settings/development.py`, `settings/production.py`
+- 🧱 Optional nested apps layout (e.g., `apps/`)
+- 🧩 App scaffolding: URLs, serializers, routes
+- 🔗 Project URLs wired automatically
+- 🧰 Utility files: `.gitignore`, `README.md`, `.env.sample`, `requirements.txt`, `pyproject.toml`
+- 🚀 Deploy helpers: `Justfile`, `Procfile`, `runtime.txt`
+- 🛠️ CI/CD: GitHub Actions and/or GitLab CI
+- 🎨 Polished UX with `rich`
+
+---
+
+## Demo
+
+![djinit demo](docs/demo.gif)
+
+Tip: If the GIF doesn't load, open `docs/demo.gif` or view it on the repository page.
+
+## Installation
+
+Using pipx (recommended):
+
+```bash
+pipx install git+https://github.com/S4NKALP/djinit
+```
+
+Using pip (user space):
+
+```bash
+pip install --user git+https://github.com/S4NKALP/djinit
+```
+
+From source:
+
+```bash
+git clone https://github.com/S4NKALP/djinit
+cd djinit
+pip install -e .
+```
+
+Requirements: Python 3.13+
+
+## Quick start
+
+Run the interactive setup:
+
+```bash
+djinit setup
+# or
+dj setup
+```
+
+Prompts include:
+
+- Project directory
+- Django project name (used by `django-admin startproject`)
+- Apps layout (flat vs nested package like `apps/`)
+- App names (comma‑separated)
+- CI/CD choice (GitHub, GitLab, both, none)
+- Database config preference (`DATABASE_URL` vs individual params)
+
+## Commands
+
+- `djinit setup` or `dj setup` — Launch the interactive project generator
+- `djinit app <names>` or `dj app <names>` — Create one or more Django apps in an existing project
+  - Examples:
+    - `djinit app users` or `dj app users`
+    - `djinit app users,products,orders` or `dj app users,products,orders`
+    - `djinit app users products orders` or `dj app users products orders`
+- `djinit secret [--count N] [--length L]` or `dj secret [--count N] [--length L]` — Print random Django `SECRET_KEY` values
+  - Example: `djinit secret --count 5 --length 50`
+
+## What gets generated
+
+- Django project and apps, then structure validation
+- Settings package and split settings
+- Base/development/production settings
+- Utility files
+- App files: `urls.py`, `serializers.py`, `routes.py`
+- Project `urls.py` (auto‑includes your apps)
+- Updated `wsgi.py`, `asgi.py`, `manage.py`
+- `Justfile`, `Procfile`, `runtime.txt`
+- CI/CD workflows (per your selection)
+
+### Output highlights
+
+- `config/settings/` → `__init__.py`, `base.py`, `development.py`, `production.py`
+- `apps/<app>/` → `urls.py`, `serializers.py`, `routes.py`
+- Project root → `.gitignore`, `README.md`, `.env.sample`, `requirements.txt`, `pyproject.toml`, `Justfile`, `Procfile`, `runtime.txt`
+- CI/CD → `.github/workflows/` and/or `.gitlab-ci.yml`
+
+Note: If you choose a nested apps package (e.g., `apps`), imports and `INSTALLED_APPS` entries are configured accordingly.
+
+## Included packages (by default)
+
+Generated `requirements.txt` includes:
+
+- Django
+- python-dotenv
+- django-jazzmin
+- djangorestframework
+- djangorestframework-simplejwt
+- drf-spectacular
+- django-cors-headers
+- whitenoise
+- psycopg2-binary
+- gunicorn
+- dj-database-url (when you opt into `DATABASE_URL`)
+
+These give you a ready‑to‑use stack with DRF, JWT auth, OpenAPI schema generation, CORS, static files in production, and Postgres support.
+
+## Environment and database
+
+- A `.env.sample` is generated to get you started.
+- If you opt into `DATABASE_URL`, `production.py` expects an environment variable like:
+  `postgres://user:password@host:port/database`
+
+## Contributing
+
+Contributions are welcome!
+Please open an issue for bugs/ideas. PRs with clear descriptions are appreciated.
+
+## Acknowledgments
+
+- Django and the Django community
+- Jinja2
+- rich
+- click
+- ruff
+
+## License
+
+MIT © Sankalp Tharu

djinitx-0.1.0/README.md

@@ -0,0 +1,142 @@
+# djinit
+
+<p align="center">
+  <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>
+</p>
+
+A fast, interactive CLI to bootstrap a modern, production‑ready Django project in minutes — featuring split settings, DRF and JWT integration, OpenAPI docs, CORS, static file handling via WhiteNoise, Postgres‑friendly configuration, CI/CD templates, deployment helpers, and battle‑tested defaults that deliver a polished developer experience out of the box.
+
+- ✨ Split settings: `settings/base.py`, `settings/development.py`, `settings/production.py`
+- 🧱 Optional nested apps layout (e.g., `apps/`)
+- 🧩 App scaffolding: URLs, serializers, routes
+- 🔗 Project URLs wired automatically
+- 🧰 Utility files: `.gitignore`, `README.md`, `.env.sample`, `requirements.txt`, `pyproject.toml`
+- 🚀 Deploy helpers: `Justfile`, `Procfile`, `runtime.txt`
+- 🛠️ CI/CD: GitHub Actions and/or GitLab CI
+- 🎨 Polished UX with `rich`
+
+---
+
+## Demo
+
+![djinit demo](docs/demo.gif)
+
+Tip: If the GIF doesn't load, open `docs/demo.gif` or view it on the repository page.
+
+## Installation
+
+Using pipx (recommended):
+
+```bash
+pipx install git+https://github.com/S4NKALP/djinit
+```
+
+Using pip (user space):
+
+```bash
+pip install --user git+https://github.com/S4NKALP/djinit
+```
+
+From source:
+
+```bash
+git clone https://github.com/S4NKALP/djinit
+cd djinit
+pip install -e .
+```
+
+Requirements: Python 3.13+
+
+## Quick start
+
+Run the interactive setup:
+
+```bash
+djinit setup
+# or
+dj setup
+```
+
+Prompts include:
+
+- Project directory
+- Django project name (used by `django-admin startproject`)
+- Apps layout (flat vs nested package like `apps/`)
+- App names (comma‑separated)
+- CI/CD choice (GitHub, GitLab, both, none)
+- Database config preference (`DATABASE_URL` vs individual params)
+
+## Commands
+
+- `djinit setup` or `dj setup` — Launch the interactive project generator
+- `djinit app <names>` or `dj app <names>` — Create one or more Django apps in an existing project
+  - Examples:
+    - `djinit app users` or `dj app users`
+    - `djinit app users,products,orders` or `dj app users,products,orders`
+    - `djinit app users products orders` or `dj app users products orders`
+- `djinit secret [--count N] [--length L]` or `dj secret [--count N] [--length L]` — Print random Django `SECRET_KEY` values
+  - Example: `djinit secret --count 5 --length 50`
+
+## What gets generated
+
+- Django project and apps, then structure validation
+- Settings package and split settings
+- Base/development/production settings
+- Utility files
+- App files: `urls.py`, `serializers.py`, `routes.py`
+- Project `urls.py` (auto‑includes your apps)
+- Updated `wsgi.py`, `asgi.py`, `manage.py`
+- `Justfile`, `Procfile`, `runtime.txt`
+- CI/CD workflows (per your selection)
+
+### Output highlights
+
+- `config/settings/` → `__init__.py`, `base.py`, `development.py`, `production.py`
+- `apps/<app>/` → `urls.py`, `serializers.py`, `routes.py`
+- Project root → `.gitignore`, `README.md`, `.env.sample`, `requirements.txt`, `pyproject.toml`, `Justfile`, `Procfile`, `runtime.txt`
+- CI/CD → `.github/workflows/` and/or `.gitlab-ci.yml`
+
+Note: If you choose a nested apps package (e.g., `apps`), imports and `INSTALLED_APPS` entries are configured accordingly.
+
+## Included packages (by default)
+
+Generated `requirements.txt` includes:
+
+- Django
+- python-dotenv
+- django-jazzmin
+- djangorestframework
+- djangorestframework-simplejwt
+- drf-spectacular
+- django-cors-headers
+- whitenoise
+- psycopg2-binary
+- gunicorn
+- dj-database-url (when you opt into `DATABASE_URL`)
+
+These give you a ready‑to‑use stack with DRF, JWT auth, OpenAPI schema generation, CORS, static files in production, and Postgres support.
+
+## Environment and database
+
+- A `.env.sample` is generated to get you started.
+- If you opt into `DATABASE_URL`, `production.py` expects an environment variable like:
+  `postgres://user:password@host:port/database`
+
+## Contributing
+
+Contributions are welcome!
+Please open an issue for bugs/ideas. PRs with clear descriptions are appreciated.
+
+## Acknowledgments
+
+- Django and the Django community
+- Jinja2
+- rich
+- click
+- ruff
+
+## License
+
+MIT © Sankalp Tharu

djinitx-0.1.0/djinit/cli.py

@@ -0,0 +1,109 @@
+"""
+Main CLI orchestrator for djinit.
+Coordinates between different managers to create a complete Django project.
+"""
+
+import os
+from typing import Callable, List, Tuple
+
+from djinit.scripts.cicd_config_generator import CICDConfigGenerator
+from djinit.scripts.console_ui import UIFormatter
+from djinit.scripts.deployment_files_generator import DeploymentConfigGenerator
+from djinit.scripts.files import FileManager
+from djinit.scripts.project import ProjectManager
+from djinit.scripts.secretkey_generator import generate_secret_command
+from djinit.scripts.settings import SettingsManager
+
+
+class Cli:
+    def __init__(self, project_dir: str, project_name: str, primary_app: str, app_names: list, metadata: dict):
+        self.project_dir = project_dir
+        self.project_name = project_name
+        self.primary_app = primary_app
+        self.app_names = app_names
+        self.metadata = metadata
+        self.project_root = os.path.join(os.getcwd(), project_dir)
+
+        # Initialize managers
+        self.project_manager = ProjectManager(project_dir, project_name, app_names, metadata)
+        self.settings_manager = SettingsManager(self.project_root, project_name, app_names, metadata)
+        self.file_manager = FileManager(self.project_root, project_name, app_names, metadata)
+        self.deployment_manager = DeploymentConfigGenerator(self.project_root, project_name)
+        self.cicd_manager = CICDConfigGenerator(self.project_root, project_name)
+
+    def run_setup(self) -> bool:
+        steps: List[Tuple[str, Callable[[], bool]]] = [
+            ("Creating Django project", self.project_manager.create_project),
+            ("Creating Django apps", self.project_manager.create_apps),
+            ("Validating project structure", self.project_manager.validate_project_structure),
+            ("Setting up project structure", self.settings_manager.create_settings_structure),
+            ("Configuring base settings", self.settings_manager.update_base_settings),
+            ("Configuring development settings", self.settings_manager.update_development_settings),
+            ("Configuring production settings", self.settings_manager.update_production_settings),
+            ("Creating utility files", self._create_utility_files),
+            ("Setting up app URLs", self.file_manager.create_app_urls),
+            ("Creating app serializers", self.file_manager.create_app_serializers),
+            ("Creating app routes", self.file_manager.create_app_routes),
+            ("Configuring comprehensive URLs", self.file_manager.update_project_urls),
+            ("Updating WSGI configuration", self.file_manager.update_wsgi_file),
+            ("Updating ASGI configuration", self.file_manager.update_asgi_file),
+            ("Updating manage.py", self.file_manager.update_manage_py),
+            ("Creating Justfile", self.deployment_manager.create_justfile),
+            ("Creating Procfile", self.deployment_manager.create_procfile),
+            ("Creating runtime.txt", lambda: self.deployment_manager.create_runtime_txt("3.13")),
+            ("Creating CI/CD pipelines", self._create_cicd_pipelines),
+        ]
+
+        total_steps = len(steps)
+        success = True
+
+        # Create live progress display
+        progress, task = UIFormatter.create_live_progress(description="Setup Progress", total_steps=total_steps)
+
+        with progress:
+            # Execute each step with progress tracking
+            for step_number, (description, step_func) in enumerate(steps, 1):
+                result = step_func()
+                if not result:
+                    success = False
+                    UIFormatter.print_error(f"Step {step_number} failed: {description}")
+                    break
+
+                # Update the same progress bar
+                progress.update(task, advance=1, description=f"Step {step_number}/{total_steps}")
+
+        return success
+
+    def _create_utility_files(self) -> bool:
+        utility_steps = [
+            self.file_manager.create_gitignore,
+            self.file_manager.create_requirements,
+            self.file_manager.create_readme,
+            self.file_manager.create_env_file,
+            lambda: self.file_manager.create_pyproject_toml(self.metadata),
+        ]
+
+        for step_func in utility_steps:
+            result = step_func()
+            if not result:
+                return False
+
+        UIFormatter.print_success("Created all utility files successfully!")
+        return True
+
+    def _create_cicd_pipelines(self) -> bool:
+        if self.metadata.get("use_github_actions", True):
+            result = self.cicd_manager.create_github_actions()
+            if not result:
+                return False
+
+        if self.metadata.get("use_gitlab_ci", True):
+            result = self.cicd_manager.create_gitlab_ci()
+            if not result:
+                return False
+
+        return True
+
+    def generate_secret_keys(self) -> bool:
+        generate_secret_command()
+        return True

djinitx-0.1.0/djinit/generator.py

@@ -0,0 +1,74 @@
+"""
+Main script entry point for djinit.
+Handles user input validation and orchestrates the setup process.
+"""
+
+import os
+import subprocess
+import sys
+
+from djinit.cli import Cli
+from djinit.scripts.command_handler import handle_app_command, handle_secret_command, parse_arguments
+from djinit.scripts.console_ui import UIFormatter, console
+from djinit.scripts.input_handler import confirm_setup, get_user_input
+
+
+def clear_screen() -> None:
+    try:
+        if os.name == "nt":
+            subprocess.run("cls", shell=True, check=True)  # Windows
+        else:
+            subprocess.run("clear", shell=True, check=True)  # Linux/MacOS
+    except subprocess.CalledProcessError:
+        # If clearing fails, just print some newlines
+        console.print("\n" * 50)
+
+
+def main() -> None:
+    # Parse command line arguments
+    args = parse_arguments()
+
+    # Handle secret command
+    if args.command == "secret":
+        handle_secret_command(args)
+        return
+
+    # Handle app command
+    if args.command == "app":
+        handle_app_command(args)
+        return
+
+    # Default to setup command
+    # Clear screen
+    clear_screen()
+
+    # Display welcome screen
+    console.print()
+    console.print(UIFormatter.create_welcome_panel())
+    console.print()
+
+    # Get user input
+    project_dir, project_name, primary_app, app_names, metadata = get_user_input()
+
+    # Confirm setup
+    if not confirm_setup(project_dir, project_name, app_names, metadata):
+        UIFormatter.print_info("Setup cancelled by user.")
+        return
+
+    # Run setup
+    console.print()
+    UIFormatter.print_info("Starting Django project setup...")
+    console.print()
+
+    django_cli = Cli(project_dir, project_name, primary_app, app_names, metadata)
+    success = django_cli.run_setup()
+
+    # Display completion summary
+    UIFormatter.create_summary_panel(project_dir, project_name, app_names, True)
+
+    # Exit with appropriate code
+    sys.exit(0 if success else 1)
+
+
+if __name__ == "__main__":
+    main()