{ "info": { "author": "Michael F Bryan", "author_email": "michaelfbryan@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 2 - Pre-Alpha", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Natural Language :: English", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5" ], "description": "=================\r\nFlask API Builder\r\n=================\r\n\r\nA really simple app that allows you to write out your RESTful APIs spec in a\r\nlogical form and automatically generate stub functions for each endpoint.\r\n\r\n\r\nInstalling\r\n==========\r\n\r\nInstall from Source\r\n-------------------\r\n\r\nTo install from source, you will need to first clone the repository from\r\nGitHub::\r\n\r\n git clone https://github.com/Michael-F-Bryan/flask_api_builder.git\r\n\r\nThen run the `setup.py` file::\r\n\r\n python3 setup.py install\r\n\r\n\r\nWith Pip\r\n--------\r\n\r\nOr you can install directly from the Python Packaging Index::\r\n\r\n pip install flask_api_builder\r\n\r\n\r\nUsage\r\n=====\r\n\r\nIn order to generate your base API, you first need to write up a spec for it.\r\nThe spec contains the definitions for each of your API's end points, as well as\r\nsome variables to customize the Blueprint each API endpoint is attached to.\r\n\r\n\r\nWriting The Spec File\r\n---------------------\r\n\r\nThe spec file is designed to be quite intuitive to use. It is set out in a\r\ntable-like format, with each column being aligned with spaces. Any line\r\nstarting with a \"#\" is interpreted as a comment and ignored by the parser.\r\n\r\n\r\nDefining Variables\r\n~~~~~~~~~~~~~~~~~~\r\n\r\nDefining variables is really easy, just add a line with `variable-name: value`.\r\nThe variable names currently supported are:\r\n\r\nBlueprint-name\r\n The name for your blueprint (defaults to \"api\")\r\nPrepend-with\r\n The path that all endpoints attached to your API Blueprint are prepended\r\n with (nothing by default)\r\nError-handlers\r\n Add pre-made 404 and 500 error handlers. They will be included unless\r\n something other than true, yes, 1, or y is entered (not case sensitive)\r\n\r\nAll variable names are **not case sensitive**.\r\n\r\n\r\nDefining Endpoints\r\n~~~~~~~~~~~~~~~~~~\r\n\r\nAPI Endpoints are defined one per line, in a table-like format. Each line\r\nconsists of 3 or 4 fields delimited by two or more whitespace characters. This\r\nmeans that you need to separate your columns by **at least** two spaces so the\r\nparser will read them correctly.\r\n\r\nThe fields correspond to an endpoint's METHOD, URL, DESCRIPTION and\r\n(optionally) the NAME of the function generated. If no name is provided then\r\none will be generated for you given the method and URL parameters (no\r\nguarantees that the generated name will be intelligible though).\r\n\r\n\r\nHere is an example of a simple spec for a to-do list app::\r\n\r\n blueprint-name: api\r\n #Method URL Description\r\n GET /tasks Retrieve list of tasks\r\n GET /tasks/ Retrieve task number \r\n POST /tasks Create a new task\r\n\r\n\r\n\r\nChangelog\r\n=========\r\n\r\n[Unreleased]\r\n------------\r\n\r\nNew Features\r\n~~~~~~~~~~~~\r\n\r\n- Added error handlers to the generated code\r\n\r\nVersion 0.1.1 (2016-44-23)\r\n--------------------------\r\n\r\nNew Features\r\n~~~~~~~~~~~~\r\n\r\n- Added a commandline option to view an example spec\r\n- Turned the module into a package and gave it a commandline entry\r\n point\r\n\r\nDocumentation Changes\r\n~~~~~~~~~~~~~~~~~~~~~\r\n\r\n- Wrote up a basic README\r\n- Added an example spec file\r\n\r\nAdministration and Chores\r\n~~~~~~~~~~~~~~~~~~~~~~~~~\r\n\r\n- Added a makefile to automate the boring stuff\r\n- Turned the module into a package with a **main**.py file\r\n- Added the ability to create sdist's and wheels properly\r\n\r\n\r\nVersion 0.1.0 (2016-05-22)\r\n--------------------------\r\n\r\nNew Features\r\n~~~~~~~~~~~~\r\n\r\n- Copied the main file from a jupyter notebook and set up the project", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/Michael-F-Bryan/flask_api_builder", "keywords": "", "license": "MIT license", "maintainer": "", "maintainer_email": "", "name": "flask_api_builder", "package_url": "https://pypi.org/project/flask_api_builder/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/flask_api_builder/", "project_urls": { "Homepage": "https://github.com/Michael-F-Bryan/flask_api_builder" }, "release_url": "https://pypi.org/project/flask_api_builder/0.2.0/", "requires_dist": null, "requires_python": null, "summary": "A shortcut for stubbing out your RESTful Flask APIs", "version": "0.2.0" }, "last_serial": 2238523, "releases": { "0.2.0": [ { "comment_text": "", "digests": { "md5": "30c717b665f9870af614f3188a9ddec9", "sha256": "70567395095906ea0463f08e1403c6768be6929c1245f6b8ae0d0eee2fcf5c59" }, "downloads": -1, "filename": "flask_api_builder-0.2.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "30c717b665f9870af614f3188a9ddec9", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 10056, "upload_time": "2016-07-22T17:37:41", "url": "https://files.pythonhosted.org/packages/14/8d/3c6f5c246e58c3e0c06c3e72d6e9e0a7eadbabc8122fd81c6fcf7b7abb8c/flask_api_builder-0.2.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "6c49e25c44a4042e37040191563fc83c", "sha256": "501c497432e08d860df01a421695be280e7ccb7f11d8a678df29d3373fc8c085" }, "downloads": -1, "filename": "flask_api_builder-0.2.0.tar.gz", "has_sig": false, "md5_digest": "6c49e25c44a4042e37040191563fc83c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7593, "upload_time": "2016-07-22T17:37:44", "url": "https://files.pythonhosted.org/packages/40/a2/a7b2a296c6643ee6af4a805840f1e2a1dd207ea5bef2e43795092c1a9302/flask_api_builder-0.2.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "30c717b665f9870af614f3188a9ddec9", "sha256": "70567395095906ea0463f08e1403c6768be6929c1245f6b8ae0d0eee2fcf5c59" }, "downloads": -1, "filename": "flask_api_builder-0.2.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "30c717b665f9870af614f3188a9ddec9", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 10056, "upload_time": "2016-07-22T17:37:41", "url": "https://files.pythonhosted.org/packages/14/8d/3c6f5c246e58c3e0c06c3e72d6e9e0a7eadbabc8122fd81c6fcf7b7abb8c/flask_api_builder-0.2.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "6c49e25c44a4042e37040191563fc83c", "sha256": "501c497432e08d860df01a421695be280e7ccb7f11d8a678df29d3373fc8c085" }, "downloads": -1, "filename": "flask_api_builder-0.2.0.tar.gz", "has_sig": false, "md5_digest": "6c49e25c44a4042e37040191563fc83c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7593, "upload_time": "2016-07-22T17:37:44", "url": "https://files.pythonhosted.org/packages/40/a2/a7b2a296c6643ee6af4a805840f1e2a1dd207ea5bef2e43795092c1a9302/flask_api_builder-0.2.0.tar.gz" } ] }