Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tavallaie/djangowiz
DjangoWiz is a toolkit for automating key components of Django projects, helping you save time and streamline development.
https://github.com/tavallaie/djangowiz
automation django python3
Last synced: 4 days ago
JSON representation
DjangoWiz is a toolkit for automating key components of Django projects, helping you save time and streamline development.
- Host: GitHub
- URL: https://github.com/tavallaie/djangowiz
- Owner: tavallaie
- License: mit
- Created: 2024-05-14T00:46:48.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-05-27T11:21:19.000Z (6 months ago)
- Last Synced: 2024-11-01T05:04:55.182Z (15 days ago)
- Topics: automation, django, python3
- Language: Python
- Homepage:
- Size: 60.5 KB
- Stars: 17
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
**_⚠️ Caution: This library is under heavy development and is not ready for production._**
# DjangoWiz
DjangoWiz is a simple and powerful toolkit to automate the generation of serializers, viewsets, URLs, and Docker configurations for your Django projects. This toolkit helps you quickly scaffold out necessary files based on your models, saving you time and effort.
## Features
- Automatically generates serializers, viewsets, and URLs based on your Django models.
- Supports generation of Dockerfile and Docker Compose configurations for development and production environments.
- Skips non-serializable classes and abstract models.
- Includes customizable templates using Jinja2.
- Provides flexible commands to generate different components individually or all together.
- Supports custom templates and single file mode.
- Can be used in other Python scripts.
## Installation
1. **Install via pip:**
```bash
pip install DjangoWiz
```
2. **Alternatively, clone the repository:**
```bash
git clone https://github.com/tavallie/DjangoWiz.git
cd DjangoWiz
```
3. **Install dependencies:**
Ensure you have Python and Poetry installed, then run:
```bash
poetry install
```
## Usage
### Generate All Files
Generate serializers, viewsets, routes, URLs, Dockerfile, and Docker Compose configurations:
```bash
djangowiz generate_files --overwrite
```
### Generate Core Files Only
Generate serializers, viewsets, and routes without Docker-related files:
```bash
djangowiz generate_core_files --overwrite
```
### Generate Individual Components
#### Generate Serializers
```bash
djangowiz generate_serializers --overwrite
```
#### Generate Viewsets
```bash
djangowiz generate_viewsets --overwrite
```
#### Generate URLs
```bash
djangowiz generate_urls --overwrite
```
#### Generate Routes
```bash
djangowiz generate_routes --overwrite
```
### Using Custom Templates
You can specify a custom template directory with the `--template-dir` option. If a custom template is not provided, the default templates will be used.
```bash
djangowiz generate_files --overwrite --template-dir path/to/custom_templates
```
### Using Single File Mode
You can generate all serializers and viewsets in a single file using the `--single-file` option.
```bash
djangowiz generate_files --overwrite --single-file
```
### Using as a Python Library
You can use DjangoWiz in your own Python scripts:
```python
from djangowiz.core import ModelExtractor, ProjectGenerator
model_file = 'path/to/models.py'
model_names = ModelExtractor.extract_model_names(model_file)
generator = ProjectGenerator('your_app', 'your_project', model_names, template_dir='path/to/custom_templates')
generator.generate_all(single_file=True, overwrite=True)
```
## Directory Structure
Ensure your project directory is structured as follows:
```
DjangoWiz/
├── djangowiz/
│ ├── __init__.py
│ ├── core.py
│ ├── cli.py
│ ├── templates/
│ ├── docker-compose.dev.yml.j2
│ ├── docker-compose.prod.yml.j2
│ ├── Dockerfile.j2
│ ├── env.dev.j2
│ ├── env.prod.j2
│ ├── serializer.py.j2
│ ├── viewset.py.j2
│ ├── urls.py.j2
│ ├── routes.py.j2
├── pyproject.toml
├── README.md
├── LICENSE
```
## Customizing Templates
The templates used for generating files are located in the `djangowiz/templates` directory. You can customize these templates to fit your project's specific requirements. The templates use Jinja2 for rendering.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
## Contributing
Contributions are welcome! Please open an issue or submit a pull request if you have any suggestions or improvements.
## Author
Ali Tavallaie - [[email protected]](mailto:[email protected])
---
Happy coding!