{ "info": { "author": "Gregory N. Schmit", "author_email": "me@gregschmit.com", "bugtrack_url": null, "classifiers": [ "Environment :: Web Environment", "Framework :: Django", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 3" ], "description": "Django REST Scaffold\n====================\n\n.. inclusion-marker-do-not-remove\n\n.. image:: https://travis-ci.org/gregschmit/django-rest-scaffold.svg?branch=master\n :target: https://travis-ci.org/gregschmit/django-rest-scaffold\n\n.. image:: https://img.shields.io/pypi/v/django-rest-scaffold\n :alt: PyPI\n :target: https://pypi.org/project/django-rest-scaffolds/\n\n.. image:: https://coveralls.io/repos/github/gregschmit/django-rest-scaffold/badge.svg?branch=master\n :target: https://coveralls.io/github/gregschmit/django-rest-scaffold?branch=master\n\nSource: https://github.com/gregschmit/django-rest-scaffold\n\nPyPI: https://pypi.org/project/django-rest-scaffolds/\n\nREST Scaffold is a Django app that provides a template tag helper for using\nthe JavaScript library ``rest-scaffold.js``.\n\n**The Problem**: Configuring ``rest-scaffold.js`` involves writing a JSON inside\nan HTML ``div`` element's ``data-rest-scaffold`` property, which is annoying\nwhen a great deal of the configuration can be figured out the Django framework.\n\n**The Solution**: This app provides a template tag that allows you to just\nspecify the model and it will build the JSON configuration for you.\n\n\nHow to Use\n==========\n\n.. code-block:: shell\n\n $ pip install django-rest-scaffolds\n\nInclude ``rest_scaffold`` in your ``INSTALLED_APPS``.\n\nBuild your API or create one using\n`AutoREST `_.\n\nThen, insert a scaffold using the ``rest_scaffold`` template tag. At the top\nyou'll need to load the template tag:\n\n..code-block:: python\n\n {% load rest_scaffold %}\n\nAnd then wherever you want in the HTML page, inject the scaffold:\n\n..code-block:: python\n\n {% rest_scaffold 'user' api_url='api' %}\n\nIn the above example, you would see a scaffold for the ``User`` model.\n\n\nContributing\n============\n\nOpen a pull request fixing a bug or implementing a feature if you want to\ncontribute. You must only contribute code that you have authored or otherwise\nhold the copyright to, and you must make any contributions to this project\navailable under the MIT license.\n\nTo collaborators: don't push using the ``--force`` option.\n\n\nDev Quickstart\n==============\n\nREST Scaffold comes with a ``settings.py`` file, technically making it a Django\nproject as well as a Django app. First clone, the repository into a location of\nyour choosing:\n\n.. code-block:: shell\n\n $ git clone https://github.com/gregschmit/django-rest-scaffold\n\nThen you can go into the ``django-rest-scaffold`` directory, install the test\nenvironment requirements, and then migrate and run the local development server:\n\n.. code-block:: shell\n\n $ cd django-rest-scaffold\n $ pip install -r requirements-test.txt\n $ python manage.py migrate\n $ python manage.py createsuperuser\n ...\n $ python manage.py runserver\n\nThen you can see the api at http://127.0.0.1:8000/api/, and you can see the\nexample scaffold page at http://127.0.0.1:8000/example/.\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/gregschmit/django-rest-scaffold", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "django-rest-scaffolds", "package_url": "https://pypi.org/project/django-rest-scaffolds/", "platform": "", "project_url": "https://pypi.org/project/django-rest-scaffolds/", "project_urls": { "Homepage": "https://github.com/gregschmit/django-rest-scaffold" }, "release_url": "https://pypi.org/project/django-rest-scaffolds/0.1.0/", "requires_dist": [ "Django (>=2)", "djangorestframework (>=3)" ], "requires_python": "", "summary": "A re-useable Django helper app for integrating rest-scaffold.js.", "version": "0.1.0" }, "last_serial": 5652443, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "72604438f8c3ba0faa4b68b8b48a0104", "sha256": "44eac23f1a0351d6a6daa1277651952b69282e5eee8be0c2fdfe28b0c989edff" }, "downloads": -1, "filename": "django_rest_scaffolds-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "72604438f8c3ba0faa4b68b8b48a0104", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 8684, "upload_time": "2019-08-08T22:09:52", "url": "https://files.pythonhosted.org/packages/29/fb/5ac40434c068f017a9516428f06c18a92e49cd4819580376b14ad4d10fcf/django_rest_scaffolds-0.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "ea8b481815c3617a640adf8e8cee8c7b", "sha256": "1e5c38aafecdf8145473e0c1ea058a7402b7453e94ff5333197e3c49b275b52f" }, "downloads": -1, "filename": "django-rest-scaffolds-0.1.0.tar.gz", "has_sig": false, "md5_digest": "ea8b481815c3617a640adf8e8cee8c7b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6239, "upload_time": "2019-08-08T22:09:54", "url": "https://files.pythonhosted.org/packages/16/c8/0adda7c658934afc01efd67b2c715b86803c24a49d32669a9819fb873d7a/django-rest-scaffolds-0.1.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "72604438f8c3ba0faa4b68b8b48a0104", "sha256": "44eac23f1a0351d6a6daa1277651952b69282e5eee8be0c2fdfe28b0c989edff" }, "downloads": -1, "filename": "django_rest_scaffolds-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "72604438f8c3ba0faa4b68b8b48a0104", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 8684, "upload_time": "2019-08-08T22:09:52", "url": "https://files.pythonhosted.org/packages/29/fb/5ac40434c068f017a9516428f06c18a92e49cd4819580376b14ad4d10fcf/django_rest_scaffolds-0.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "ea8b481815c3617a640adf8e8cee8c7b", "sha256": "1e5c38aafecdf8145473e0c1ea058a7402b7453e94ff5333197e3c49b275b52f" }, "downloads": -1, "filename": "django-rest-scaffolds-0.1.0.tar.gz", "has_sig": false, "md5_digest": "ea8b481815c3617a640adf8e8cee8c7b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6239, "upload_time": "2019-08-08T22:09:54", "url": "https://files.pythonhosted.org/packages/16/c8/0adda7c658934afc01efd67b2c715b86803c24a49d32669a9819fb873d7a/django-rest-scaffolds-0.1.0.tar.gz" } ] }