{ "info": { "author": "Optic", "author_email": "acunniffe@gmail.com", "bugtrack_url": null, "classifiers": [], "description": "# Optic for Django \n\n## Optic Proxy Setup\nPython APIs built in Django are easy to connect to Optic using our custom middleware. In this tutorial we'll show you how to connect the Optic Documenting Middleware to your Django app so that your integration tests document your code as they execute. \n\n## Add the Middleware to your Project\nInstall the Optic Documenting Middleware using pip\n```bash\npip3 install optic-document-django\n``` \n\n### Making the Middleware Run During Testing\nNow add the middleware to the `settings.py` file that configures the Django API. You should put the middleware at the very bottom of the stack. \n```python\nMIDDLEWARE = [\n 'django.middleware.common.CommonMiddleware',\n 'optic.DocumentDjango'\n]\n``` \n\n## Using the Middleware in your tests\nThe Documenting middleware will document all the requests/responses that your tests run. Since it is integrated at the middleware level there's no need to update any of your tests files or fixtures. \n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/opticdev/api-ingestion", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "optic-document-django", "package_url": "https://pypi.org/project/optic-document-django/", "platform": "", "project_url": "https://pypi.org/project/optic-document-django/", "project_urls": { "Homepage": "https://github.com/opticdev/api-ingestion" }, "release_url": "https://pypi.org/project/optic-document-django/0.1.4/", "requires_dist": [ "django" ], "requires_python": "", "summary": "Document a django API with Optic", "version": "0.1.4" }, "last_serial": 5094405, "releases": { "0.1.3": [ { "comment_text": "", "digests": { "md5": "573950202a7c18e98aec3e90e7db0156", "sha256": "eb0d53404c6b10bab243ea7bc92bc5bdd2eb1075d82591656f3e8bc1433d1fd9" }, "downloads": -1, "filename": "optic_document_django-0.1.3-py3-none-any.whl", "has_sig": false, "md5_digest": "573950202a7c18e98aec3e90e7db0156", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 3495, "upload_time": "2019-04-04T04:24:15", "url": "https://files.pythonhosted.org/packages/7f/db/5d5fd5fca0a35465d17eab40cc424133055a7c0ceb2e5c5eff5a50212b37/optic_document_django-0.1.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "e19e093a6087031c557110ef3f15fb07", "sha256": "8bf9fe035f0049747766296cd44cd7c21066f65046d3f1afa629a28bb4ad479b" }, "downloads": -1, "filename": "optic-document-django-0.1.3.tar.gz", "has_sig": false, "md5_digest": "e19e093a6087031c557110ef3f15fb07", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2459, "upload_time": "2019-04-04T04:24:17", "url": "https://files.pythonhosted.org/packages/14/32/447c1b4420c1d599439b039e642088df860d23d73e0a3312419374638a2e/optic-document-django-0.1.3.tar.gz" } ], "0.1.4": [ { "comment_text": "", "digests": { "md5": "8162d654199f9b3ac2e50e4f717566ee", "sha256": "3b064f4603b9a079584014216564bebe2fe21fed62df7f440dd8b72fc5e57907" }, "downloads": -1, "filename": "optic_document_django-0.1.4-py3-none-any.whl", "has_sig": false, "md5_digest": "8162d654199f9b3ac2e50e4f717566ee", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 3391, "upload_time": "2019-04-04T04:44:09", "url": "https://files.pythonhosted.org/packages/bb/40/ed327d78aaa7c19c0aa8d0677aae2fd9ea1d868f172fb55458d1012a52c2/optic_document_django-0.1.4-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1fe6f0b66f79b69b2835745208a30fc7", "sha256": "1d86dfc1bc07f6c533f56bf8f8c33018e69df11911cead0c5ecc53e919b0ca39" }, "downloads": -1, "filename": "optic-document-django-0.1.4.tar.gz", "has_sig": false, "md5_digest": "1fe6f0b66f79b69b2835745208a30fc7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2341, "upload_time": "2019-04-04T04:44:10", "url": "https://files.pythonhosted.org/packages/60/91/2122643151ce587510fc19f74b52012fd049173bcb4b9eeb657c5dee9d56/optic-document-django-0.1.4.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "8162d654199f9b3ac2e50e4f717566ee", "sha256": "3b064f4603b9a079584014216564bebe2fe21fed62df7f440dd8b72fc5e57907" }, "downloads": -1, "filename": "optic_document_django-0.1.4-py3-none-any.whl", "has_sig": false, "md5_digest": "8162d654199f9b3ac2e50e4f717566ee", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 3391, "upload_time": "2019-04-04T04:44:09", "url": "https://files.pythonhosted.org/packages/bb/40/ed327d78aaa7c19c0aa8d0677aae2fd9ea1d868f172fb55458d1012a52c2/optic_document_django-0.1.4-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1fe6f0b66f79b69b2835745208a30fc7", "sha256": "1d86dfc1bc07f6c533f56bf8f8c33018e69df11911cead0c5ecc53e919b0ca39" }, "downloads": -1, "filename": "optic-document-django-0.1.4.tar.gz", "has_sig": false, "md5_digest": "1fe6f0b66f79b69b2835745208a30fc7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2341, "upload_time": "2019-04-04T04:44:10", "url": "https://files.pythonhosted.org/packages/60/91/2122643151ce587510fc19f74b52012fd049173bcb4b9eeb657c5dee9d56/optic-document-django-0.1.4.tar.gz" } ] }