Metadata-Version: 2.1 Name: flask-restx Version: 1.3.0 Summary: Fully featured framework for fast, easy and documented API development with Flask Home-page: https://github.com/python-restx/flask-restx Author: python-restx Authors License: BSD-3-Clause Keywords: flask restx rest api swagger openapi Classifier: Development Status :: 5 - Production/Stable Classifier: Programming Language :: Python Classifier: Environment :: Web Environment Classifier: Operating System :: OS Independent Classifier: Intended Audience :: Developers Classifier: Topic :: System :: Software Distribution Classifier: Programming Language :: Python Classifier: Programming Language :: Python :: 3 Classifier: Programming Language :: Python :: 3.8 Classifier: Programming Language :: Python :: 3.9 Classifier: Programming Language :: Python :: 3.10 Classifier: Programming Language :: Python :: 3.11 Classifier: Programming Language :: Python :: 3.12 Classifier: Programming Language :: Python :: Implementation :: PyPy Classifier: Topic :: Software Development :: Libraries :: Python Modules Classifier: License :: OSI Approved :: BSD License License-File: LICENSE Requires-Dist: aniso8601 >=0.82 Requires-Dist: jsonschema Requires-Dist: Flask !=2.0.0,>=0.8 Requires-Dist: werkzeug !=2.0.0 Requires-Dist: pytz Requires-Dist: importlib-resources Provides-Extra: dev Requires-Dist: blinker ; extra == 'dev' Requires-Dist: Faker ==2.0.0 ; extra == 'dev' Requires-Dist: mock ==3.0.5 ; extra == 'dev' Requires-Dist: pytest ==7.0.1 ; extra == 'dev' Requires-Dist: pytest-benchmark ==3.4.1 ; extra == 'dev' Requires-Dist: pytest-cov ==4.0.0 ; extra == 'dev' Requires-Dist: pytest-flask ==1.3.0 ; extra == 'dev' Requires-Dist: pytest-mock ==3.6.1 ; extra == 'dev' Requires-Dist: pytest-profiling ==1.7.0 ; extra == 'dev' Requires-Dist: tzlocal ; extra == 'dev' Requires-Dist: invoke ==2.2.0 ; extra == 'dev' Requires-Dist: twine ==3.8.0 ; extra == 'dev' Requires-Dist: setuptools ; extra == 'dev' Requires-Dist: tox ; extra == 'dev' Requires-Dist: black ; extra == 'dev' Provides-Extra: doc Requires-Dist: alabaster ==0.7.12 ; extra == 'doc' Requires-Dist: Sphinx ==5.3.0 ; extra == 'doc' Requires-Dist: sphinx-issues ==3.0.1 ; extra == 'doc' Provides-Extra: test Requires-Dist: blinker ; extra == 'test' Requires-Dist: Faker ==2.0.0 ; extra == 'test' Requires-Dist: mock ==3.0.5 ; extra == 'test' Requires-Dist: pytest ==7.0.1 ; extra == 'test' Requires-Dist: pytest-benchmark ==3.4.1 ; extra == 'test' Requires-Dist: pytest-cov ==4.0.0 ; extra == 'test' Requires-Dist: pytest-flask ==1.3.0 ; extra == 'test' Requires-Dist: pytest-mock ==3.6.1 ; extra == 'test' Requires-Dist: pytest-profiling ==1.7.0 ; extra == 'test' Requires-Dist: tzlocal ; extra == 'test' Requires-Dist: invoke ==2.2.0 ; extra == 'test' Requires-Dist: twine ==3.8.0 ; extra == 'test' Requires-Dist: setuptools ; extra == 'test' =========== Flask RESTX =========== .. image:: https://github.com/python-restx/flask-restx/workflows/Tests/badge.svg?tag=1.3.0&event=push :target: https://github.com/python-restx/flask-restx/actions?query=workflow%3ATests :alt: Tests status .. image:: https://codecov.io/gh/python-restx/flask-restx/branch/master/graph/badge.svg :target: https://codecov.io/gh/python-restx/flask-restx :alt: Code coverage .. image:: https://readthedocs.org/projects/flask-restx/badge/?version=1.3.0 :target: https://flask-restx.readthedocs.io/en/1.3.0/ :alt: Documentation status .. image:: https://img.shields.io/pypi/l/flask-restx.svg :target: https://pypi.org/project/flask-restx :alt: License .. image:: https://img.shields.io/pypi/pyversions/flask-restx.svg :target: https://pypi.org/project/flask-restx :alt: Supported Python versions .. image:: https://badges.gitter.im/Join%20Chat.svg :target: https://gitter.im/python-restx?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge :alt: Join the chat at https://gitter.im/python-restx .. image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/psf/black :alt: Code style: black Flask-RESTX is a community driven fork of `Flask-RESTPlus `_. Flask-RESTX is an extension for `Flask`_ that adds support for quickly building REST APIs. Flask-RESTX encourages best practices with minimal setup. If you are familiar with Flask, Flask-RESTX should be easy to pick up. It provides a coherent collection of decorators and tools to describe your API and expose its documentation properly using `Swagger`_. Compatibility ============= Flask-RESTX requires Python 3.8+. On Flask Compatibility ====================== Flask and Werkzeug moved to versions 2.0 in March 2020. This caused a breaking change in Flask-RESTX. .. list-table:: RESTX and Flask / Werkzeug Compatibility :widths: 25 25 25 :header-rows: 1 * - Flask-RESTX version - Flask version - Note * - <= 0.3.0 - < 2.0.0 - unpinned in Flask-RESTX. Pin your projects! * - == 0.4.0 - < 2.0.0 - pinned in Flask-RESTX. * - >= 0.5.0 - < 3.0.0 - unpinned, import statements wrapped for compatibility * - == 1.2.0 - < 3.0.0 - pinned in Flask-RESTX. * - >= 1.3.0 - >= 2.0.0 (Flask >= 3.0.0 support) - unpinned, import statements wrapped for compatibility * - trunk branch in Github - >= 2.0.0 (Flask >= 3.0.0 support) - unpinned, will address issues faster than releases. Installation ============ You can install Flask-RESTX with pip: .. code-block:: console $ pip install flask-restx or with easy_install: .. code-block:: console $ easy_install flask-restx Quick start =========== With Flask-RESTX, you only import the api instance to route and document your endpoints. .. code-block:: python from flask import Flask from flask_restx import Api, Resource, fields app = Flask(__name__) api = Api(app, version='1.0', title='TodoMVC API', description='A simple TodoMVC API', ) ns = api.namespace('todos', description='TODO operations') todo = api.model('Todo', { 'id': fields.Integer(readonly=True, description='The task unique identifier'), 'task': fields.String(required=True, description='The task details') }) class TodoDAO(object): def __init__(self): self.counter = 0 self.todos = [] def get(self, id): for todo in self.todos: if todo['id'] == id: return todo api.abort(404, "Todo {} doesn't exist".format(id)) def create(self, data): todo = data todo['id'] = self.counter = self.counter + 1 self.todos.append(todo) return todo def update(self, id, data): todo = self.get(id) todo.update(data) return todo def delete(self, id): todo = self.get(id) self.todos.remove(todo) DAO = TodoDAO() DAO.create({'task': 'Build an API'}) DAO.create({'task': '?????'}) DAO.create({'task': 'profit!'}) @ns.route('/') class TodoList(Resource): '''Shows a list of all todos, and lets you POST to add new tasks''' @ns.doc('list_todos') @ns.marshal_list_with(todo) def get(self): '''List all tasks''' return DAO.todos @ns.doc('create_todo') @ns.expect(todo) @ns.marshal_with(todo, code=201) def post(self): '''Create a new task''' return DAO.create(api.payload), 201 @ns.route('/') @ns.response(404, 'Todo not found') @ns.param('id', 'The task identifier') class Todo(Resource): '''Show a single todo item and lets you delete them''' @ns.doc('get_todo') @ns.marshal_with(todo) def get(self, id): '''Fetch a given resource''' return DAO.get(id) @ns.doc('delete_todo') @ns.response(204, 'Todo deleted') def delete(self, id): '''Delete a task given its identifier''' DAO.delete(id) return '', 204 @ns.expect(todo) @ns.marshal_with(todo) def put(self, id): '''Update a task given its identifier''' return DAO.update(id, api.payload) if __name__ == '__main__': app.run(debug=True) Contributors ============ Flask-RESTX is brought to you by @python-restx. Since early 2019 @SteadBytes, @a-luna, @j5awry, @ziirish volunteered to help @python-restx keep the project up and running, they did so for a long time! Since the beginning of 2023, the project is maintained by @peter-doggart with help from @ziirish. Of course everyone is welcome to contribute and we will be happy to review your PR's or answer to your issues. Documentation ============= The documentation is hosted `on Read the Docs `_ .. _Flask: https://flask.palletsprojects.com/ .. _Swagger: https://swagger.io/ Contribution ============ Want to contribute! That's awesome! Check out `CONTRIBUTING.rst! `_