A re-useable Django app for automatically building a REST API based on models.
Project description
AutoREST
Documentation: https://django-autorest.readthedocs.io
Source: https://github.com/gregschmit/django-autorest
PyPI: https://pypi.org/project/django-autorest/
AutoREST is a reusable Django app for building REST APIs from model definitions.
The Problem: Building APIs for models is boring.
The Solution: This app builds them for you and you can just focus on the custom stuff.
How to Use
$ pip install django-autorest
Include autorest in your INSTALLED_APPS. Then, in
Contributing
Email gschmi4@uic.edu 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
AutoREST 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-autorest
Then you can go into the django-autorest directory and do the initial migrations and run the server (you may need to type python3 rather than python):
$ cd django-autorest
$ 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/.
To Do
Build endpoints based on admin.py configuration (this should be optional, using a settings.py switch, like AUTOREST_USE_ADMIN_PY) - Rigth now, simple models like the auth.Group work, however complex models like the auth.User don’t because the create API endpoint should take password/confirmation not the raw password hash.
Build CRUD forms for the endpoints (maybe a generator)
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
Built Distribution
Hashes for django_autorest-0.1.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 109f852daf6176f016ee5f035f6a14a4e985352168a087eeb37f1cfc77b1489a |
|
MD5 | c5334904c61fc1e24e377497916eee38 |
|
BLAKE2b-256 | 8801eecf2331378557b5135be6c166b70b784725f4c3f829d2664482a97c2371 |