Metadata-Version: 2.1
Name: django-hogwarts
Version: 0.2.2
Summary: Django utilities for codegen and DX improvement
Home-page: https://github.com/adiletto64/django-hogwarts
Keywords: django,django-utils,codegen
Author: adiletto64
Author-email: adiletdj19@gmail.com
Requires-Python: >=3.9,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: Jinja2 (>=3.1.2,<4.0.0)
Project-URL: Documentation, https://django-hogwarts.vercel.app/
Project-URL: Repository, https://github.com/adiletto64/django-hogwarts
Description-Content-Type: text/markdown

<h1 align="center">Django hogwarts 🧙‍♂️</h1>
<h4 align="center">Management commands to generate views, urls and templates!</h4>

> [!WARNING]
> Customization and documentation are incomplete 

Use CLI commands to generate:
- basic create, update, list, detail views
- urlpatterns from views with REST like path urls
- form, table, detail templates (Bootstrap and django-crispy-forms by default)

[checkout docs](https://django-hogwarts.vercel.app/)

---

## Installation
```shell
# pip
pip install django-hogwarts

# poetry
poetry add --dev django-hogwarts
```

add `hogwarts` to your `INSTALLED_APPS`:
``` python
INSTALLED_APPS = [
    ...
    "hogwarts"
]
```

## Usage

### Generate urls.py

```
python manage.py genurls <your-app-name>
```

Arguments:
- `--merge`, `-m` add new paths without changing existing paths in urls.py
- `--force-app-name`, `fan` override app_name in urls.py 

### Generate views.py
```
python manage.py genviews <your-app-name> <model-name>
```
Arguments
- `smart-mode`, `-s` adds login required, sets user for CreateView and checks if client is owner of object in UpdateView
- `model-is-namespace`, `-mn` adds success_url with name model as [namespace](https://docs.djangoproject.com/en/4.2/topics/http/urls/#url-namespaces)

### Generate templates
``` 
python manage.py gentemplates <your-app-name>
```

