{ "info": { "author": "Denis Tormazov", "author_email": "hulygun@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Topic :: Software Development :: Build Tools" ], "description": "Very simple app for REST API create via Django Framework\n========================================================\n\n.. image:: https://travis-ci.org/hulygun/django-api-toolkit.svg?branch=master\n :alt: Build Status\n :target: https://travis-ci.org/hulygun/django-api-toolkit\n\n.. image:: https://img.shields.io/pypi/v/django-api-toolkit.svg\n :alt: pypi\n :target: https://pypi.org/project/django-api-toolkit/\n\n.. image:: https://img.shields.io/pypi/pyversions/django-api-toolkit.svg\n :alt: python\n :target: https://pypi.org/project/django-api-toolkit/\n\n.. image:: https://img.shields.io/pypi/l/django-api-toolkit.svg\n :alt: license\n :target: https://pypi.org/project/django-api-toolkit/\n\n.. image:: https://img.shields.io/pypi/status/django-api-toolkit.svg\n :alt: Development status\n :target: https://pypi.org/project/django-api-toolkit/\n\n.. image:: https://coveralls.io/repos/github/hulygun/django-api-toolkit/badge.svg?branch=master\n :target: https://coveralls.io/github/hulygun/django-api-toolkit?branch=master\n\n\n\n.. contents::\n\nInstalation\n-----------\n.. code-block:: bash\n\n pip install django-api-toolkit\n\nGet started\n-----------\n\nIn the first you need initialize your project\n\n.. code-block:: bash\n\n project_init \n\nFor existing projects you should to generate **env** file\n\n.. code-block:: bash\n\n env_generator \n\nThis script generate base variables that needed to run project. You can also add youself variables in env file\nYou should also change your **manage.py**. Add *APIManager* to your file. e.q.\n\n.. code-block:: python\n\n #!/usr/bin/env python\n import sys\n\n from api_tools.utils import APIManager\n\n if __name__ == \"__main__\":\n er = APIManager(__file__, 'cfg.settings') # path to user project settings\n er.set_app_dir('apps') # directory for user project applications\n er.apply() # apply settings\n\n from django.core.management import execute_from_command_line\n execute_from_command_line(sys.argv)\n\n\nUsage\n-----\n\nStructure\n~~~~~~~~~\n\n.. code-block:: bash\n\n \u251c\u2500\u2500 apps # dir for your apps\n \u251c\u2500\u2500 cfg # dir for diferent project configurations\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 settings.py # user project settings\n \u2502\u00a0\u00a0 \u2514\u2500\u2500 wsgi.py\n \u2514\u2500\u2500 manage.py\n\n\nSettings\n~~~~~~~~\n\n- **COMMON_APPS** - django common applications\n- **THIRD_PARTY_APPS** - third party applications\n- **EXTRA_APPS** - applications should be insted before common apps\n- **PROJECT_APPS** - your project applications\n\nYou also can overwrite other standard django settings keys and add yourself variables\n\nModels\n~~~~~~\n\nAll project models should be inherited of RestModel(this standart django abstract model and you can use all capabilities\nof this)\n\n.. code-block:: python\n\n from api_tools.models import RestModel\n\n class MyModel(RestModel):\n ...\n\nAdvanced\n--------\n\n**RestModel** have subclass **Rest**. This subclass have properties for control your rest models. RestModel also have\nclassmethods for these controls.\n\n\nRestModel overwrites\n~~~~~~~~~~~~~~~~~~~~\n\nRestModel.Rest\n..............\n\n:queryset: defines queryset as **lambda** of :code:`model.objects`\n:fields: list of allowed fields of model\n:name: name of viewset\n:route: route of endpoint\n\nRestModel._rest_serializer\n..........................\n\nDefines serializer for viewset of model\n\nRestModel._rest_queryset\n........................\n\nDefines queryset for viewset\n\nRestModel._rest_endpoint\n........................\n\nSet endpoint for your model\n\nFEATURES\n--------\n\nCHANGELOG\n---------", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/hulygun/django-api-toolkit", "keywords": "api rest django", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "django-api-toolkit", "package_url": "https://pypi.org/project/django-api-toolkit/", "platform": "", "project_url": "https://pypi.org/project/django-api-toolkit/", "project_urls": { "Homepage": "https://github.com/hulygun/django-api-toolkit" }, "release_url": "https://pypi.org/project/django-api-toolkit/0.1.6/", "requires_dist": null, "requires_python": ">=3.5", "summary": "", "version": "0.1.6" }, "last_serial": 3044802, "releases": { "0.0.2": [ { "comment_text": "", "digests": { "md5": "557fd668e9047fff29c29d469d8ce94b", "sha256": "2fa2a2b59af15e78f087232150edfb3d67cec8d184de5782cb673fc99299906f" }, "downloads": -1, "filename": "django_api_toolkit-0.0.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "557fd668e9047fff29c29d469d8ce94b", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": ">=3.5", "size": 7185, "upload_time": "2017-07-04T15:58:04", "url": "https://files.pythonhosted.org/packages/1b/bc/ec07bb6d85f1359f518d8f6713aba4b76199de23d9a92707fa202f327481/django_api_toolkit-0.0.2-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "523244d505f0e01afebd2a7dd630974d", "sha256": "06179ee82183d83dd658aa01b6986e3e38cab46cc6cb6ad5288a7e923e86c8da" }, "downloads": -1, "filename": "django-api-toolkit-0.0.2.tar.gz", "has_sig": false, "md5_digest": "523244d505f0e01afebd2a7dd630974d", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 5292, "upload_time": "2017-07-04T15:58:06", "url": "https://files.pythonhosted.org/packages/3c/89/a84d57cfbefa41e3fb175440c09efa3ac6b58cf99de140634cd7d08d06f2/django-api-toolkit-0.0.2.tar.gz" } ], "0.0.3": [ { "comment_text": "", "digests": { "md5": "cbe0eb767702de8b5f9820e5a6a4aa0a", "sha256": "40ea3ea316d9dd5ac9ad20d8767935f251d01ce874b025fdf386cceb01d8dc64" }, "downloads": -1, "filename": "django-api-toolkit-0.0.3.tar.gz", "has_sig": false, "md5_digest": "cbe0eb767702de8b5f9820e5a6a4aa0a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5254, "upload_time": "2017-07-04T16:05:14", "url": "https://files.pythonhosted.org/packages/83/99/b36afe2699dce544554454c520c3f9e75b960279a656b95218ea8abcd021/django-api-toolkit-0.0.3.tar.gz" } ], "0.0.4": [ { "comment_text": "", "digests": { "md5": "a3b09c3f0461869aeba7fee6efac3e4a", "sha256": "17f5843400a7cd6b4957b10cddb6b387e55ce133cb0a0e9a03b822e15233f2a0" }, "downloads": -1, "filename": "django-api-toolkit-0.0.4.tar.gz", "has_sig": false, "md5_digest": "a3b09c3f0461869aeba7fee6efac3e4a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6317, "upload_time": "2017-07-05T02:48:18", "url": "https://files.pythonhosted.org/packages/72/bf/278f8e28ed94bb377a2c52d5d6ad456e6f082b4b6bd2dabb61f946f57803/django-api-toolkit-0.0.4.tar.gz" } ], "0.0.5a1": [ { "comment_text": "", "digests": { "md5": "6ad36d7f55d9e76dc0e2bf43030fabda", "sha256": "183f3da355c9c4056c2ceefa202f0930f81f286af7e4c27fdd1e807b2a4d6fe5" }, "downloads": -1, "filename": "django-api-toolkit-0.0.5a1.tar.gz", "has_sig": false, "md5_digest": "6ad36d7f55d9e76dc0e2bf43030fabda", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6993, "upload_time": "2017-07-05T04:03:07", "url": "https://files.pythonhosted.org/packages/35/43/f2382a9a40edeec5862b4499a52c194b75782450d348794a74040554998e/django-api-toolkit-0.0.5a1.tar.gz" } ], "0.1.0": [ { "comment_text": "", "digests": { "md5": "2b41a861ee75857d9cf1e68ef0afe153", "sha256": "a6b1dc11a853705cd47120c0a1eba6c4523c3bec743214bee4e2c8ed4df2f1ad" }, "downloads": -1, "filename": "django-api-toolkit-0.1.0.tar.gz", "has_sig": false, "md5_digest": "2b41a861ee75857d9cf1e68ef0afe153", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7519, "upload_time": "2017-07-06T11:25:01", "url": "https://files.pythonhosted.org/packages/26/c9/6047168a11f4d118c9124e534c1b5bd125b39a9a28c227c16fd4a6057cb4/django-api-toolkit-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "8e1b17a50b39914e5027ce8a7de0b987", "sha256": "d1e8c4ac9ad4557c785d7b2824b77fa4521d84ef2aa5c580456d7caede5896b1" }, "downloads": -1, "filename": "django-api-toolkit-0.1.1.tar.gz", "has_sig": false, "md5_digest": "8e1b17a50b39914e5027ce8a7de0b987", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 7617, "upload_time": "2017-07-06T13:17:02", "url": "https://files.pythonhosted.org/packages/93/d4/a383960acd1ca06250a1048caa1c2e488fa3e7f520cedb2911ae788c7f5d/django-api-toolkit-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "bd38f91163508de1c620eb35fc4a770b", "sha256": "3f320c548b180867ff7bd76168754ebcac925b0988fdc5d144e1efd94fa5cb08" }, "downloads": -1, "filename": "django-api-toolkit-0.1.2.tar.gz", "has_sig": false, "md5_digest": "bd38f91163508de1c620eb35fc4a770b", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 7687, "upload_time": "2017-07-06T14:30:27", "url": "https://files.pythonhosted.org/packages/4a/eb/ac48b3273d6d6bdcfb4ce34633430f78cd6382ffdca99176038e43b0eae1/django-api-toolkit-0.1.2.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "9a8a3cf249007c27883c008bd718ce79", "sha256": "ca2fbab1c370642a1c66f85f49b40361224208b4c66857d5cf1ca54365b095fd" }, "downloads": -1, "filename": "django-api-toolkit-0.1.3.tar.gz", "has_sig": false, "md5_digest": "9a8a3cf249007c27883c008bd718ce79", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 7693, "upload_time": "2017-07-06T14:45:31", "url": "https://files.pythonhosted.org/packages/62/a7/6f4d627e9c359af6b9b4bd45a23c66fc7443033cb9c37cce56ed3fa6fa56/django-api-toolkit-0.1.3.tar.gz" } ], "0.1.4": [ { "comment_text": "", "digests": { "md5": "859b58e35ac9eabec1490a63b25538f3", "sha256": "10757c69a16eb48c5b71e9bffc698560f217850e9ffbbd1ca3e9068ccd25f4b4" }, "downloads": -1, "filename": "django-api-toolkit-0.1.4.tar.gz", "has_sig": false, "md5_digest": "859b58e35ac9eabec1490a63b25538f3", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 7691, "upload_time": "2017-07-06T15:15:37", "url": "https://files.pythonhosted.org/packages/d1/52/7194169a13df58bc5aedf4ece08729848399d66cb0e271d16aaee0a790bb/django-api-toolkit-0.1.4.tar.gz" } ], "0.1.5": [ { "comment_text": "", "digests": { "md5": "bfafa41d11b0d1a7f395f164b3f54ad5", "sha256": "951c338960cfdddc092b1e2c364682f9b1bad2fde3b2c38445494e9614c4b055" }, "downloads": -1, "filename": "django-api-toolkit-0.1.5.tar.gz", "has_sig": false, "md5_digest": "bfafa41d11b0d1a7f395f164b3f54ad5", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 7690, "upload_time": "2017-07-06T15:31:28", "url": "https://files.pythonhosted.org/packages/b3/84/199ce02d91c053adffb7b6d3142bf1c29753ee4c783cdffd7f2f97443a18/django-api-toolkit-0.1.5.tar.gz" } ], "0.1.6": [ { "comment_text": "", "digests": { "md5": "7e5f6b7d777abea3f4efe4549d2cb9e5", "sha256": "e62411f01578ad193838a2930bd5fa59a442355016c15e7da69eb68cf1d1248c" }, "downloads": -1, "filename": "django-api-toolkit-0.1.6.tar.gz", "has_sig": false, "md5_digest": "7e5f6b7d777abea3f4efe4549d2cb9e5", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 7772, "upload_time": "2017-07-24T13:26:24", "url": "https://files.pythonhosted.org/packages/3a/e2/60bc0d1e304a4ab94748a8432e982291c29f29dfd1907fe64a211ec53624/django-api-toolkit-0.1.6.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "7e5f6b7d777abea3f4efe4549d2cb9e5", "sha256": "e62411f01578ad193838a2930bd5fa59a442355016c15e7da69eb68cf1d1248c" }, "downloads": -1, "filename": "django-api-toolkit-0.1.6.tar.gz", "has_sig": false, "md5_digest": "7e5f6b7d777abea3f4efe4549d2cb9e5", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 7772, "upload_time": "2017-07-24T13:26:24", "url": "https://files.pythonhosted.org/packages/3a/e2/60bc0d1e304a4ab94748a8432e982291c29f29dfd1907fe64a211ec53624/django-api-toolkit-0.1.6.tar.gz" } ] }