Metadata-Version: 2.4
Name: djforge
Version: 0.2.0
Summary: A tiny cookiecutter-style CLI for simple Django starter projects.
Project-URL: Homepage, https://github.com/siyadhkc/djforge
Project-URL: Repository, https://github.com/siyadhkc/djforge
Project-URL: Issues, https://github.com/siyadhkc/djforge/issues
Project-URL: Changelog, https://github.com/siyadhkc/djforge/blob/main/CHANGELOG.md
Author: djforge contributors
License: MIT License
        
        Copyright (c) 2026 djforge contributors
        
        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.
License-File: LICENSE
Keywords: boilerplate,cli,django,generator,scaffold
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Code Generators
Requires-Python: >=3.11
Requires-Dist: jinja2>=3
Requires-Dist: questionary>=2
Requires-Dist: rich>=13
Requires-Dist: typer>=0.12
Provides-Extra: dev
Requires-Dist: black; extra == 'dev'
Requires-Dist: hatch; extra == 'dev'
Requires-Dist: isort; extra == 'dev'
Requires-Dist: pytest-cov; extra == 'dev'
Requires-Dist: pytest>=8; extra == 'dev'
Requires-Dist: ruff; extra == 'dev'
Description-Content-Type: text/markdown

# djforge

A small CLI that generates simple Django starter projects. Think of it as a tiny,
focused cousin of cookiecutter-django: fewer questions, fewer files, quick output.

## Install

```bash
pip install djforge
```

For local development:

```bash
pip install -e ".[dev]"
```

## Usage

Create a basic Django project with SQLite:

```bash
djforge new mysite --yes
```

Create an API starter with Django REST Framework:

```bash
djforge new myapi --preset api --yes
```

Create a fuller Docker/PostgreSQL starter:

```bash
djforge new myshop --preset fullstack --yes
```

Use prompts instead of `--yes`:

```bash
djforge new mysite
```

List available presets:

```bash
djforge list-presets
```

## Presets

| Preset | Database | API | Docker |
| --- | --- | --- | --- |
| minimal | SQLite | no | no |
| api | SQLite | yes | no |
| fullstack | PostgreSQL | yes | yes |

## Generated Project

The generated project includes:

- `manage.py`
- one Django settings module
- a `core` app with a JSON health endpoint
- `.env.example` and copied `.env`
- `requirements.txt`
- `Makefile`
- `pyproject.toml`
- optional DRF, Dockerfile, and docker-compose.yml

Example:

```text
mysite/
├── manage.py
├── requirements.txt
├── Makefile
├── .env.example
├── pyproject.toml
└── mysite/
    ├── settings.py
    ├── urls.py
    ├── asgi.py
    ├── wsgi.py
    └── core/
        ├── apps.py
        ├── urls.py
        ├── views.py
        └── tests.py
```

## Development

```bash
python -m pytest -p no:cacheprovider
python -m py_compile djforge\config.py djforge\renderer.py djforge\cli.py
```

## Release

1. Update `version` in `pyproject.toml` and `__version__` in `djforge/__init__.py`.
2. Add a changelog entry.
3. Run checks:

```bash
python -m pytest tests/test_core.py tests/test_e2e.py -q -p no:cacheprovider
python -m ruff check djforge tests
python -m hatch build
```

4.Upload only the new version files:

```bash
python -m twine upload dist/djforge-0.2.0.tar.gz dist/djforge-0.2.0-py3-none-any.whl
```
