Metadata-Version: 2.1
Name: django-crudgen
Version: 0.1.0
Summary: A simple package to generate CRUD views for Django models.
Home-page: https://github.com/mohammadkhoddami/django-crudgen
Author: Mohammad Hasan Khoddami
Author-email: mohammadh.khoddami@gmail.com
License: MIT
Classifier: Programming Language :: Python :: 3
Classifier: Framework :: Django
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: django>=3.0

# Django CRUDgen

## 📌 Introduction
`django-crudgen` is a Django package that **automatically generates CRUD views and templates** for your Django models. Just install the package, add it to `INSTALLED_APPS`, and let it handle the repetitive CRUD work for you!

## 🚀 Installation
Install the package using pip:
```sh
pip install crudgen
```

Then, add `crudgen` to your `INSTALLED_APPS` in `settings.py`:
```python
INSTALLED_APPS = [
    ...,
    "crudgen",  # Enable the package
]
```

## 🛠 Usage
### 1️⃣ **Register the CRUD views for your models**
In your `urls.py`, import and use the `generate_crud_urls` function:
```python
from django.urls import path, include
from crud_builder.generators import generate_crud_urls
from myapp.models import MyModel

urlpatterns = [
    path("mymodel/", include(generate_crud_urls(MyModel, "my_app_name"))),
]
```
This will automatically create URLs for listing, creating, updating, and deleting `MyModel` objects.

### 2️⃣ **Access the CRUD Views**
Once the URLs are registered, you can access them via:
- `http://127.0.0.1:8000/mymodel/` (List view)
- `http://127.0.0.1:8000/mymodel/create/` (Create view)
- `http://127.0.0.1:8000/mymodel/<int:pk>/` (Detail view)
- `http://127.0.0.1:8000/mymodel/<int:pk>/update/` (Update view)
- `http://127.0.0.1:8000/mymodel/<int:pk>/delete/` (Delete view)

### 3️⃣ **Customize Templates**
The package provides default templates inside:
```
crud_builder/templates/crud_builder/
```
You can override them by creating your own templates in your app's `templates/` directory.

## 📜 License
This package is licensed under the MIT License.

## ❤️ Contributing
Feel free to submit issues and pull requests on GitHub!

## 📬 Contact
For any questions, reach out at mohammadh.khoddami@gmail.com.

