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.3.tar.gz (12.0 kB view details)

Uploaded Source

Built Distribution

dr_scaffold-1.0.3-py3-none-any.whl (14.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: dr_scaffold-1.0.3.tar.gz
  • Upload date:
  • Size: 12.0 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.3.tar.gz
Algorithm Hash digest
SHA256 6f4e071481f7fbc790ef86e2124718c0b14ef68452632c048745d2518edd3653
MD5 fae31dfe11a16118a811013ff49abc1f
BLAKE2b-256 49804005600f977ca1ed2f14dc58b0814f64f5a22888064c6087b70204e15e33

See more details on using hashes here.

File details

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

File metadata

  • Download URL: dr_scaffold-1.0.3-py3-none-any.whl
  • Upload date:
  • Size: 14.4 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 ed354bad5f0bd26c31e7fa6c0f406fca91a712b2dce28313c20cd00e05144738
MD5 03f6058b2ca271184a0c2c92740cd66d
BLAKE2b-256 c051962a8b5bde698348a6219ee06b2aedab9613a378e81917a8775f53ad924f

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