MohamedTaha123 / dr_scaffold

scaffold django rest apis like a champion 🚀

dr_scaffold

Scaffold django rest apis like a champion ⚡. said no one before

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'
]

If you are using a custom API structure, 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