{
"info": {
"author": "Michal Nowotka",
"author_email": "mnowotka@ebi.ac.uk",
"bugtrack_url": null,
"classifiers": [
"Development Status :: 3 - Alpha",
"Environment :: Web Environment",
"Framework :: Django",
"Intended Audience :: Developers",
"License :: OSI Approved :: Apache Software License",
"Operating System :: POSIX :: Linux",
"Programming Language :: Python :: 2.7",
"Topic :: Software Development :: Documentation"
],
"description": "tastypie_spore_docs\n======\n\n.. image:: https://img.shields.io/pypi/v/tastypie_spore_docs.svg\n :target: https://pypi.python.org/pypi/tastypie_spore_docs/\n :alt: Latest Version\n\n.. image:: https://img.shields.io/pypi/dm/tastypie_spore_docs.svg\n :target: https://pypi.python.org/pypi/tastypie_spore_docs/\n :alt: Downloads\n\n.. image:: https://img.shields.io/pypi/pyversions/tastypie_spore_docs.svg\n :target: https://pypi.python.org/pypi/tastypie_spore_docs/\n :alt: Supported Python versions\n\n.. image:: https://img.shields.io/pypi/status/tastypie_spore_docs.svg\n :target: https://pypi.python.org/pypi/tastypie_spore_docs/\n :alt: Development Status\n\n.. image:: https://img.shields.io/pypi/l/tastypie_spore_docs.svg\n :target: https://pypi.python.org/pypi/tastypie_spore_docs/\n :alt: License\n\n\nThis is tastypie_spore_docs package developed at Chembl group, EMBL-EBI, Cambridge, UK.\n\nThis package generates live online documentation as a SPORE client from the tastypie REST endpoint.\n\nRationale?\n--------\n\nImagine you have just finished your `Tastypie-based `_\n`REST `_\n`API `_.\nYou would probably like to encourage some developers to use it.\nBut how to do it without documentation?\nDocumentation is important but it's also boring to write.\nAnd since people will read the documentation online, from their browsers they could execute your REST API as well.\n\n\nThis library solves all your problems - it generates live online documentation for you.\nIt can inspect your tastypie API, get all available methods and generate a nice online documentation, where everyone\ncan try them.\nIt does this by generating a `SPORE `_\nendpoint and providing JavaScript-based client which consumes the\nendpoint and renders documentation.\n\nSetting it up\n--------\n\nAs with every Django application, the first thing to do is to add it to ``INSTALLED_APPS`` list.::\n\n INSTALLED_APPS = (\n ...\n 'tastypie_spore_docs',\n ...\n )\n\nApart from this, there is one required parameter that you have to include in your ``settings.py``.\nIt is called ``TASTYPIE_DOC_API`` and it should be a string containing a dotted path to your tastypie api instance.::\n\n TASTYPIE_DOC_API = 'path.to.rest.api'\n\nThere is another, optional parameter called ``TASTYPIE_DOC_NAME``, which will be a title on the documentation page.::\n\n TASTYPIE_DOC_NAME = 'My brand new documentation'\n\nThis application provides an url conf so you need to include it in your ``urls.py`` in order to see it.\n\nCustomising method required parameters and description\n--------\n\nSometime your REST method requires more than one parameter or requires some custom description.\nYou can customise this by adding ``required_params`` and ``descriptions`` dictionaries to your tastypie resource ``Meta`` class.\nFor both dictionaries, the keys should be a method name (for example ``api_get_detail``).\nThe value is a list of parameter names (strings) for ``required_params`` and string with description for ``descriptions``.\n\n\nTemplate Customisation\n--------\n\nThis app provides two templates: ``docs.html`` and ``head_banner.html``.\n``docs.html`` sets up a SPORE client and should be modified.\n``head_banner.html`` adds custom content to the to of documentation and should be extended/overwritten.\n",
"description_content_type": null,
"docs_url": null,
"download_url": "",
"downloads": {
"last_day": -1,
"last_month": -1,
"last_week": -1
},
"home_page": "https://www.ebi.ac.uk/chembldb/index.php/ws",
"keywords": "",
"license": "Apache Software License",
"maintainer": "",
"maintainer_email": "",
"name": "tastypie_spore_docs",
"package_url": "https://pypi.org/project/tastypie_spore_docs/",
"platform": "",
"project_url": "https://pypi.org/project/tastypie_spore_docs/",
"project_urls": {
"Homepage": "https://www.ebi.ac.uk/chembldb/index.php/ws"
},
"release_url": "https://pypi.org/project/tastypie_spore_docs/0.1.9/",
"requires_dist": null,
"requires_python": "",
"summary": "This Django app generates SPORE endpoint from Tastypie REST API and provides a JavaScript based SPORE client.",
"version": "0.1.9"
},
"last_serial": 2752453,
"releases": {
"0.1.2": [
{
"comment_text": "",
"digests": {
"md5": "fa06115a22ddb8d507f1b8a7331d058b",
"sha256": "1c511ac506795803c6efc2202f5e22ba1521a7354bd19d4466e9751caa21cd1f"
},
"downloads": -1,
"filename": "tastypie_spore_docs-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "fa06115a22ddb8d507f1b8a7331d058b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 245603,
"upload_time": "2015-01-12T10:24:30",
"url": "https://files.pythonhosted.org/packages/34/e0/04d31a95b3829df85b3847d6ba599a2c75a1d8b83b4394c281a55a3e4c86/tastypie_spore_docs-0.1.2.tar.gz"
}
],
"0.1.5": [
{
"comment_text": "",
"digests": {
"md5": "c1698209f070fecc2662be60c20e9257",
"sha256": "db36adead3218189dd1faea215d027f3437e1b66723d178a9434f937639c55dd"
},
"downloads": -1,
"filename": "tastypie_spore_docs-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "c1698209f070fecc2662be60c20e9257",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 245979,
"upload_time": "2015-06-16T13:59:50",
"url": "https://files.pythonhosted.org/packages/94/eb/7d571fa642a5aa88ca1dedaa42388ad0817e4008a3b31085f795cf19302c/tastypie_spore_docs-0.1.5.tar.gz"
}
],
"0.1.9": [
{
"comment_text": "",
"digests": {
"md5": "adce6ad0f62aee1a2d4a6423386e2943",
"sha256": "7357cac286559bee14fa4d831eb77ce2291a80823b3ba07e1871817b128ac820"
},
"downloads": -1,
"filename": "tastypie-spore-docs-0.1.9.tar.gz",
"has_sig": false,
"md5_digest": "adce6ad0f62aee1a2d4a6423386e2943",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 246063,
"upload_time": "2017-04-04T16:22:48",
"url": "https://files.pythonhosted.org/packages/ef/f3/d48d46eaa5ec1df84f4bf195dffb1609d382492e97e92fac44940bd502a0/tastypie-spore-docs-0.1.9.tar.gz"
}
]
},
"urls": [
{
"comment_text": "",
"digests": {
"md5": "adce6ad0f62aee1a2d4a6423386e2943",
"sha256": "7357cac286559bee14fa4d831eb77ce2291a80823b3ba07e1871817b128ac820"
},
"downloads": -1,
"filename": "tastypie-spore-docs-0.1.9.tar.gz",
"has_sig": false,
"md5_digest": "adce6ad0f62aee1a2d4a6423386e2943",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 246063,
"upload_time": "2017-04-04T16:22:48",
"url": "https://files.pythonhosted.org/packages/ef/f3/d48d46eaa5ec1df84f4bf195dffb1609d382492e97e92fac44940bd502a0/tastypie-spore-docs-0.1.9.tar.gz"
}
]
}