Metadata-Version: 2.1
Name: dr_scaffold
Version: 1.0.2
Summary: a Django package for scaffolding django rest apis using cli
Home-page: https://github.com/Abdenasser/dr_scaffold
Author: abdenasser
Author-email: nasser.elidrissi065@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
License-File: LICENSE


Overview
--------

This library will help you to scaffold full **Restful API Resources** in seconds using only one command:

.. code:: console

    $ 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 <https://www.abdenasser.com/scaffold-django-apis>`_


This library assumes that you have setup your project with **Django Rest
Framework**.
if not, please refer to `this guide <https://www.django-rest-framework.org/#installation>`_

Install dr_scaffold package :

.. code:: console

    $ pip install dr-scaffold

Add ``dr_scaffold`` to your INSTALLED\_APPS like this:

.. code:: python

    INSTALLED_APPS = [
        ...
        'dr_scaffold'
    ]

Enjoy 🎉



Supported field types
---------------------

We support most of django field types.

TODO
----

-  add an option to include swagger documentation
-  handle DRF ViewSets using Mixins



