Metadata-Version: 2.1
Name: flask-rebar
Version: 1.12.2
Summary: Flask-Rebar combines flask, marshmallow, and swagger for robust REST services.
Home-page: https://github.com/plangrid/flask-rebar
Author: Barak Alon
Author-email: barak.s.alon@gmail.com
License: MIT
Description: Flask-Rebar
        ===========
        
        .. image:: https://readthedocs.org/projects/flask-rebar/badge/?version=latest
           :target: http://flask-rebar.readthedocs.io/en/latest/?badge=latest
           :alt: Documentation Status
        
        .. image:: https://travis-ci.org/plangrid/flask-rebar.svg?branch=master
           :target: https://travis-ci.org/plangrid/flask-rebar
           :alt: CI Status
        
        .. image:: https://badge.fury.io/py/flask-rebar.svg
           :target: https://badge.fury.io/py/flask-rebar
           :alt: PyPI status
        
        .. image:: https://img.shields.io/badge/code%20style-black-000000.svg
           :target: https://github.com/ambv/black
           :alt: Code style
        
        .. image:: https://img.shields.io/badge/Contributor%20Covenant-v1.4%20adopted-ff69b4.svg
           :target: https://www.contributor-covenant.org/
           :alt: Code of Conduct
        
        |
        
        Flask-Rebar combines `flask <http://flask.pocoo.org/>`_, `marshmallow <https://marshmallow.readthedocs.io/en/latest/>`_, and `swagger <https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md>`_ for robust REST services.
        
        
        Features
        --------
        
        * **Request and Response Validation** - Flask-Rebar relies on schemas from the popular Marshmallow package to validate incoming requests and marshal outgoing responses.
        * **Automatic Swagger Generation** - The same schemas used for validation and marshaling are used to automatically generate OpenAPI specifications (a.k.a. Swagger). This also means automatic documentation via `Swagger UI <https://swagger.io/swagger-ui/>`_.
        * **Error Handling** - Uncaught exceptions from Flask-Rebar are converted to appropriate HTTP errors.
        
        
        Example
        -------
        
        .. code-block:: python
        
           from flask import Flask
           from flask_rebar import errors, Rebar
           from marshmallow import fields, Schema
        
           from my_app import database
        
        
           rebar = Rebar()
        
           # All handler URL rules will be prefixed by '/v1'
           registry = rebar.create_handler_registry(prefix='/v1')
        
           class TodoSchema(Schema):
               id = fields.Integer()
               complete = fields.Boolean()
               description = fields.String()
        
           # This schema will validate the incoming request's query string
           class GetTodosQueryStringSchema(Schema):
               complete = fields.Boolean()
        
           # This schema will marshal the outgoing response
           class GetTodosResponseSchema(Schema):
               data = fields.Nested(TodoSchema, many=True)
        
        
           @registry.handles(
               rule='/todos',
               method='GET',
               query_string_schema=GetTodosQueryStringSchema(),
               response_body_schema=GetTodosResponseSchema(), # for versions <= 1.7.0, use marshal_schema
           )
           def get_todos():
               """
               This docstring will be rendered as the operation's description in
               the auto-generated OpenAPI specification.
               """
               # The query string has already been validated by `query_string_schema`
               complete = rebar.validated_args.get('complete')
        
               ...
        
               # Errors are converted to appropriate HTTP errors
               raise errors.Forbidden()
        
               ...
        
               # The response will be marshaled by `marshal_schema`
               return {'data': []}
        
        
           def create_app(name):
               app = Flask(name)
               rebar.init_app(app)
               return app
        
        
           if __name__ == '__main__':
               create_app(__name__).run()
        
        
        For a more complete example, check out the example app at `examples/todo.py <examples/todo/todo.py>`_. Some example requests to this example app can be found at `examples/todo_output.md <examples/todo/todo_output.md>`_.
        
        
        Installation
        ------------
        
        .. code-block::
        
           pip install flask-rebar
        
        
        Documentation
        -------------
        
        More extensive documentation can be found  `here <https://flask-rebar.readthedocs.io>`_.
        
        
        Extensions
        ----------
        
        Flask-Rebar is extensible! Here are some open source extensions:
        
        * `Flask-Rebar-Auth0 <https://github.com/Sytten/flask-rebar-auth0>`_ - `Auth0 <https://auth0.com/>`_ authenticator for Flask-Rebar
        
        
        Contributing
        ------------
        
        There is still work to be done, and contributions are encouraged! Check out the `contribution guide <CONTRIBUTING.rst>`_ for more information.
        
Keywords: flask,rest,marshmallow,openapi,swagger
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Framework :: Flask
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Application
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Provides-Extra: dev
