Skip to main content

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

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dr_scaffold-1.0.2.tar.gz (11.5 kB view hashes)

Uploaded Source

Built Distribution

dr_scaffold-1.0.2-py3-none-any.whl (13.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page