django-rest-scaffold

A re-useable Django helper app for integrating rest-scaffold.js.


License
MIT
Install
pip install django-rest-scaffold==0.0.1a4

Documentation

Django REST Scaffold

TravisCI Coveralls Code Style

Source: https://github.com/gregschmit/django-rest-scaffold

REST Scaffold is a Django app that provides a template tag helper for using the JavaScript library rest-scaffold.js.

The Problem: Configuring rest-scaffold.js involves writing a JSON inside an HTML div element's data-rest-scaffold property, which is annoying when a great deal of the configuration can be figured out the Django framework.

The Solution: This app provides a template tag that allows you to just specify the model and it will build the JSON configuration for you.

How to Use

$ pip install git+https://github.com/gregschmit/django-rest-scaffold

Include rest_scaffold in your INSTALLED_APPS.

Build your API or create one using AutoREST.

Then, insert a scaffold using the rest_scaffold template tag. At the top you'll need to load the template tag:

{% load rest_scaffold %}

And then wherever you want in the HTML page, inject the scaffold:

{% rest_scaffold 'user' api_url='api' %}

In the above example, you would see a scaffold for the User model.

Contributing

Open a pull request fixing a bug or implementing a feature if you want to contribute. You must only contribute code that you have authored or otherwise hold the copyright to, and you must make any contributions to this project available under the MIT license.

To collaborators: don't push using the --force option.

Dev Quickstart

REST Scaffold comes with a settings.py file, technically making it a Django project as well as a Django app. First clone, the repository into a location of your choosing:

$ git clone https://github.com/gregschmit/django-rest-scaffold

Then you can go into the django-rest-scaffold directory, install the test environment requirements, and then migrate and run the local development server:

$ cd django-rest-scaffold
$ pip install -r requirements-test.txt
$ python manage.py migrate
$ python manage.py createsuperuser
...
$ python manage.py runserver

Then you can see the api at http://127.0.0.1:8000/api/, and you can see the example scaffold page at http://127.0.0.1:8000/example/.