a Django package for scaffolding django rest apis using cli
Project description
Overview
This library will help you to scaffold full Restful API Resources in seconds using only one command:
$ python manage.py dr_scaffold blog Post body:textfield author:foreignkey:Author
🎉 Your RESTful Post api resource is ready 🎉
models.py with Models and fields generated by the CLI ⚡
admin.py with Models registered and ready ⚡
views.py with appropriate ViewSets ready⚡
urls.py with appropriate URLs ready.⚡
serializers.py with Model Serializers ready ⚡
and more …
Installation and usage
For a detailed guide read scaffold django apis like a champion
This library assumes that you have setup your project with Django Rest Framework. if not, please refer to this guide
Install dr_scaffold package :
$ pip install dr-scaffold
Add dr_scaffold to your INSTALLED_APPS like this:
INSTALLED_APPS = [
...
'dr_scaffold'
]
Add CORE_FOLDER and API_FOLDER to your settings.py include a forward slash at the end of each:
CORE_FOLDER = "my_core_folder/" # you can leave them empty
API_FOLDER = "my_api_folder/" # or set them to be the same
Enjoy 🎉
Supported field types
We support most of django field types.
TODO
add an option to include swagger documentation
handle DRF ViewSets using Mixins
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for dr_scaffold-1.4.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1d5724436436f082b9b8e307089965ec0548f2c83313e722235490c2d0f43e49 |
|
MD5 | 52d4c9ce73ff14ad36399f4bfba5c832 |
|
BLAKE2b-256 | e3c9ddf41b486bb7574451b852a7ef557addab47f4d3a7fcdcea0065b2136df5 |