Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/py-universe/django-rest-cli
Scaffold your Django Rest(DRF) projects faster with DR-CLI⚡🚀
https://github.com/py-universe/django-rest-cli
developer-tool django python rest-api tooling
Last synced: 3 months ago
JSON representation
Scaffold your Django Rest(DRF) projects faster with DR-CLI⚡🚀
- Host: GitHub
- URL: https://github.com/py-universe/django-rest-cli
- Owner: py-universe
- License: mit
- Created: 2022-04-21T08:59:25.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-06-11T17:45:37.000Z (over 2 years ago)
- Last Synced: 2024-08-02T16:22:12.542Z (3 months ago)
- Topics: developer-tool, django, python, rest-api, tooling
- Language: Python
- Homepage:
- Size: 312 KB
- Stars: 120
- Watchers: 4
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-django-rest-framework - django-rest-cli
- stars - py-universe/django-rest-cli - Scaffold your Django Rest(DRF) projects faster with DR-CLI⚡🚀 (Python)
- stars - py-universe/django-rest-cli - Scaffold your Django Rest(DRF) projects faster with DR-CLI⚡🚀 (Python)
README
Django Rest CLI ✨
Scaffold your DRF project with common python packages configured, auto-generated docs, auto-generated CRUD endpoints, code linting with pre-commit hook, and more⚡🚀
## What is Django Rest CLI ?
A CLI tool for _rapid_ Rest APIs development. It abstracts the repeated aspects of building a REST API with the Django Framework by:
- Allowing you start your project from one of three templates. Each template comes with features you'd most likely be setting up yourself already configured for you.
- Allowing you define your models and have this tool generate CRUD endpoints for each model defined.
For example, if you define a model, **Product** in your `models.py` file, this tool could generate a _GET /products POST /products PUT /products/_ etc. endpoints for that model.
- Allowing you create all the apps in your project at once, if you know them before hand.
## Demo
## Getting Started
### Installation
```pip install dr-cli```
I highly recommend that you install this in a virtual environment.
### Create a New Project
- Run ```dr-cli startproject project_name``` to start a new DRF project.
- You'd be prompted to start your project from one of three templates: **Basic, Medior, and Advanced** templates. Learn more about what each template comes bundled with [here](https://github.com/py-universe/django-rest-cli/blob/docs/templatesInfo.md).
- On selecting one of the templates your project will then be created. Git will be initialized in your project, and all project dependencies installed as shown in the image below:
The generated project comes with a nice Readme containing the steps for running the project
### Create New Apps in your Project
- Run ```dr-cli startapps todo me-nu user``` to create multiple Django apps in your project. Where `todo me-nu user` are your app names.
- Running the above command will create all your apps. Name validations would also be performed as shown in the image below:
**Note** Make sure to add your created apps to the list of INSTALLED APPS
### Generate CRUD Endpoints for your Apps
- Run ```dr-cli addcrud memo user``` to create CRUD endpoints for the models defined in the specified apps.
- Running the above command would return a nice looking feedback as shown in the image below:
**Note** Make sure to register the `URLs` for each app in the top level `urls.py` file.
On Windows, Emojis are only supported in [Windows Terminal Preview](https://www.microsoft.com/en-us/p/windows-terminal-preview/9n8g5rfz9xk3?activetab=pivot:overviewtab)
### Accessing the docs page
- Run `python manage.py runserver` to fire up your local development server, and point your browser to `http://localhost:8000/api/v1/docs` to view the auto-generated docs page shown in the image below:
## Motivation
I've documented my motivation for working on this tool [here](https://dev.to/nyior/dr-cli-a-flexible-cookie-cutter-and-crud-endpoints-generator-for-django-2nlb).
## Contributing Guide
Coming soon...
## Acknowledgements
In building this I re-used a few parts of these repositories in this project:
- [django-classy-start](https://github.com/mfonism/django-classy-start)
- [dr-scaffold](https://github.com/Abdenasser/dr_scaffold)
## I Love this, how can I thank you Nyior?
Please let your developer friends know about this repo :) If you star this repo too I won't complain xD
## Limitations
Python310 isn't supported in this project yet. We are working on it.
## Licence
MIT