{ "info": { "author": "Gregory N. Schmit", "author_email": "gschmi4@uic.edu", "bugtrack_url": null, "classifiers": [ "Environment :: Web Environment", "Framework :: Django", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 3" ], "description": "AutoREST\n========\n\n.. inclusion-marker-do-not-remove\n\n.. image:: https://travis-ci.org/gregschmit/django-autorest.svg?branch=master\n :alt: TravisCI\n :target: https://travis-ci.org/gregschmit/django-autorest\n\n.. image:: https://img.shields.io/pypi/v/django-autorest\n :alt: PyPI\n :target: https://pypi.org/project/django-autorest/\n\n.. image:: https://coveralls.io/repos/github/gregschmit/django-autorest/badge.svg?branch=master\n :alt: Coveralls\n :target: https://coveralls.io/github/gregschmit/django-autorest?branch=master\n\n.. image:: https://readthedocs.org/projects/django-autorest/badge/?version=latest\n :alt: Documentation Status\n :target: https://django-autorest.readthedocs.io/en/latest/?badge=latest\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :alt: Code Style\n :target: https://github.com/ambv/black\n\nDocumentation: https://django-autorest.readthedocs.io\n\nSource: https://github.com/gregschmit/django-autorest\n\nPyPI: https://pypi.org/project/django-autorest/\n\nAutoREST is a reusable Django app for building REST APIs from model definitions and\n(optionally) ``admin.py`` definitions.\n\n**The Problem**: Building APIs for models is boring.\n\n**The Solution**: This app builds them for you, optionally using your AdminSite as a\nguide, and you can just focus on the custom stuff.\n\n\nHow to Use\n==========\n\n.. code-block:: shell\n\n $ pip install django-autorest\n\nInclude ``autorest`` in your ``INSTALLED_APPS``.\n\n\nSettings\n--------\n\n- ``AUTOREST_ADMIN_SITE`` (default ``'django.contrib.admin.site'``): This is an import\n string to the admin site where ``autorest`` can get hints on how the API should be\n configured (e.g., list display fields, edit fields, readonly fields, etc). To disable\n this feature entirely, just set this to ``False``.\n- ``AUTOREST_DEFAULT_USE_ADMIN_SITE`` (default ``False``): Whether the default model\n functionality should be to get config hints from ``admin.py``.\n- ``AUTOREST_DEFAULT_ENABLE`` (default: ``True``): Whether API ViewSets/URLs should be\n built for models which don't have an explicit entry in the ``AUTOREST_CONFIG``. If\n this option is ``False``, then only models defined in the ``AUTOREST_CONFIG`` will\n have URLs generated for them.\n- ``AUTOREST_CONFIG`` default:\n\n.. code-block:: python\n\n {\n 'auth': {\n 'User': {\n 'viewset': 'autorest.sample_user_viewset.UserViewSet',\n },\n },\n }\n\n\n``AUTOREST_CONFIG`` Options:\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\n- ``use_admin_site``: Whether to use the admin site to build the API.\n- ``serializer``: An import string to a serializer instance. (Note: if you would use\n multiple serializers for different actions like list/detail, then you can use\n `drf-action-serializer `_) to\n configure a single serializer that supports per-action field configuration.)\n- ``viewset``: An import string to a full viewset for this model.\n\n\nContributing\n============\n\nSubmit a pull request if you would like to contribute. You must only contribute code\nthat you have authored or otherwise hold the copyright to, and you must make any\ncontributions to this project available under the MIT license.\n\nDevelopment\n===========\n\nAutoREST comes with a ``settings.py`` file, allowing it to run as a standalone project.\n\n.. code-block:: shell\n\n $ git clone https://github.com/gregschmit/django-autorest\n\nThen you can go into the ``django-autorest`` directory and do the initial migrations and\nrun the server (you may need to type ``python3`` rather than ``python``):\n\n.. code-block:: shell\n\n $ cd django-autorest\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/.\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-autorest", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "django-autorest", "package_url": "https://pypi.org/project/django-autorest/", "platform": "", "project_url": "https://pypi.org/project/django-autorest/", "project_urls": { "Homepage": "https://github.com/gregschmit/django-autorest" }, "release_url": "https://pypi.org/project/django-autorest/1.0.0/", "requires_dist": [ "Django (>=2)", "djangorestframework (>=3)", "inflection" ], "requires_python": "", "summary": "A re-useable Django app for automatically building a REST API based on models.", "version": "1.0.0" }, "last_serial": 5830174, "releases": { "0.1.3": [ { "comment_text": "", "digests": { "md5": "c5334904c61fc1e24e377497916eee38", "sha256": "109f852daf6176f016ee5f035f6a14a4e985352168a087eeb37f1cfc77b1489a" }, "downloads": -1, "filename": "django_autorest-0.1.3-py3-none-any.whl", "has_sig": false, "md5_digest": "c5334904c61fc1e24e377497916eee38", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 9194, "upload_time": "2019-07-02T21:44:45", "url": "https://files.pythonhosted.org/packages/88/01/eecf2331378557b5135be6c166b70b784725f4c3f829d2664482a97c2371/django_autorest-0.1.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "93469a53623b1434111a6728ef3e8dfa", "sha256": "e44a10895f965f28b383be667a707e581c1ed242bf53572ba2c5b5278ce28bd5" }, "downloads": -1, "filename": "django-autorest-0.1.3.tar.gz", "has_sig": false, "md5_digest": "93469a53623b1434111a6728ef3e8dfa", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6299, "upload_time": "2019-07-02T21:44:47", "url": "https://files.pythonhosted.org/packages/39/b1/3299a8b4408750e0400f303736fa63fd8a0fb76895c0fb5c43df61bdfb60/django-autorest-0.1.3.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "61fa9e49b4c54038d7994a4d4acdabc9", "sha256": "6987b1e8c2e827143c575c1240dfef5658c212c80ae04049018f5522904bc1bf" }, "downloads": -1, "filename": "django_autorest-0.2.1-py3-none-any.whl", "has_sig": false, "md5_digest": "61fa9e49b4c54038d7994a4d4acdabc9", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 12814, "upload_time": "2019-07-19T06:48:49", "url": "https://files.pythonhosted.org/packages/bb/84/b7fc1d87d7b1c3e85c8446ca21dc44c09f9da32ac1b98bdc9b76ffc2bf88/django_autorest-0.2.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "0637f23621b1ea2c18479d96aeae230f", "sha256": "3b4004bed01317eb5c4b2cb955f049530c8977adbeb7a9b2533e59983214f5a3" }, "downloads": -1, "filename": "django-autorest-0.2.1.tar.gz", "has_sig": false, "md5_digest": "0637f23621b1ea2c18479d96aeae230f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11056, "upload_time": "2019-07-19T06:48:51", "url": "https://files.pythonhosted.org/packages/32/e0/a940118340a3e5a0ed85990812bc6dbe763f5adb2858fb0eefdb2470b274/django-autorest-0.2.1.tar.gz" } ], "0.2.5": [ { "comment_text": "", "digests": { "md5": "c7f48ad14401f329938db189133ddc59", "sha256": "b786fb7d0665ffb86f6b11186a0368ea5ac112a9fd8ab8cb6c72038c9ae1ec2b" }, "downloads": -1, "filename": "django_autorest-0.2.5-py3-none-any.whl", "has_sig": false, "md5_digest": "c7f48ad14401f329938db189133ddc59", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 14204, "upload_time": "2019-07-26T00:18:36", "url": "https://files.pythonhosted.org/packages/80/7d/1a9821cd610dfd30597c36a399bc1ee48f1302f47290533ec73f91dd5d34/django_autorest-0.2.5-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1b61c4930f36d1fe9e8f005e3ab34dbd", "sha256": "a2f47e1ea8f86dea06c3563cca4525857eba7eb4d80ad91c35726c0ff40714ab" }, "downloads": -1, "filename": "django-autorest-0.2.5.tar.gz", "has_sig": false, "md5_digest": "1b61c4930f36d1fe9e8f005e3ab34dbd", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12742, "upload_time": "2019-07-26T00:18:38", "url": "https://files.pythonhosted.org/packages/51/95/73b4dd89e85e3ba98cf26e3943356f4ced575acb9ee141fce21447badba4/django-autorest-0.2.5.tar.gz" } ], "0.7.1": [ { "comment_text": "", "digests": { "md5": "e51b6aca8fc8736f0c5ed9deb15025f2", "sha256": "1e939639022067cd9d6d1a82575943451d04942ca56312e9647c3dd0a07b64ba" }, "downloads": -1, "filename": "django_autorest-0.7.1-py3-none-any.whl", "has_sig": false, "md5_digest": "e51b6aca8fc8736f0c5ed9deb15025f2", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 14249, "upload_time": "2019-07-26T00:25:52", "url": "https://files.pythonhosted.org/packages/dc/75/7a888c8e13047e3419253121a379be1740b3d1b11b03a22d0c75e0e869b3/django_autorest-0.7.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "d1e55a702d6d54b429e050f839e46181", "sha256": "a1b95dd0ece02168cfc8bef49bf789bf363fabaea750398f87d1a02635fd8da0" }, "downloads": -1, "filename": "django-autorest-0.7.1.tar.gz", "has_sig": false, "md5_digest": "d1e55a702d6d54b429e050f839e46181", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12831, "upload_time": "2019-07-26T00:25:58", "url": "https://files.pythonhosted.org/packages/f6/f6/55aced32d541387475782a994eb6216ed23e28c084d866567083c087214a/django-autorest-0.7.1.tar.gz" } ], "1.0.0": [ { "comment_text": "", "digests": { "md5": "691b960074e5885893aecdda2775dbf8", "sha256": "d598c7f8b12f9ab278d532bc0cb55cd4d4272159ebff6c7e62ab86ecdf6b4517" }, "downloads": -1, "filename": "django_autorest-1.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "691b960074e5885893aecdda2775dbf8", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 11961, "upload_time": "2019-09-14T20:45:22", "url": "https://files.pythonhosted.org/packages/f2/b9/19cd0dc8801d838d9c6161ccabbe8c9be85ce2094be497f53418a9829678/django_autorest-1.0.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "32d5cc24219c0c2416901e96b1c722c5", "sha256": "cf71b701c29b3c1ea5557a0f29cbe48a170d243a1980aafc1996632edfd51b4a" }, "downloads": -1, "filename": "django-autorest-1.0.0.tar.gz", "has_sig": false, "md5_digest": "32d5cc24219c0c2416901e96b1c722c5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10824, "upload_time": "2019-09-14T20:45:24", "url": "https://files.pythonhosted.org/packages/09/a8/cceef896267a42c449918215df8d0f722abf13704ae845c580950c81b6c8/django-autorest-1.0.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "691b960074e5885893aecdda2775dbf8", "sha256": "d598c7f8b12f9ab278d532bc0cb55cd4d4272159ebff6c7e62ab86ecdf6b4517" }, "downloads": -1, "filename": "django_autorest-1.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "691b960074e5885893aecdda2775dbf8", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 11961, "upload_time": "2019-09-14T20:45:22", "url": "https://files.pythonhosted.org/packages/f2/b9/19cd0dc8801d838d9c6161ccabbe8c9be85ce2094be497f53418a9829678/django_autorest-1.0.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "32d5cc24219c0c2416901e96b1c722c5", "sha256": "cf71b701c29b3c1ea5557a0f29cbe48a170d243a1980aafc1996632edfd51b4a" }, "downloads": -1, "filename": "django-autorest-1.0.0.tar.gz", "has_sig": false, "md5_digest": "32d5cc24219c0c2416901e96b1c722c5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10824, "upload_time": "2019-09-14T20:45:24", "url": "https://files.pythonhosted.org/packages/09/a8/cceef896267a42c449918215df8d0f722abf13704ae845c580950c81b6c8/django-autorest-1.0.0.tar.gz" } ] }