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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file dr_scaffold-1.0.2.tar.gz.

File metadata

  • Download URL: dr_scaffold-1.0.2.tar.gz
  • Upload date:
  • Size: 11.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.4 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.1 CPython/3.9.5

File hashes

Hashes for dr_scaffold-1.0.2.tar.gz
Algorithm Hash digest
SHA256 51bfb95f5695627e1abfbeeb1f0fb4766c347a9a8e39484fd31b559d696c6d06
MD5 4cdc19b4bd2b38c4cca383f879d71ddc
BLAKE2b-256 3499baf6ee216935a9f82c5d03eb11456f84465f2d23080c853c701c0bd20213

See more details on using hashes here.

File details

Details for the file dr_scaffold-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: dr_scaffold-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 13.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.4 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.1 CPython/3.9.5

File hashes

Hashes for dr_scaffold-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d749f235731e85c244a1b31249a1a0ff1d099a902117c152495a53cfd62b50c8
MD5 8cefdcf64aa59ecc78b94a9522056b82
BLAKE2b-256 6f0d6347c97445963ccb69f63116e029577df1f9cab06b9a8c907b346b920e6a

See more details on using hashes here.

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