Metadata-Version: 2.1
Name: falcon-heavy
Version: 0.1.2
Summary: The framework for building app backends and microservices by specification-first API design approach based on the OpenAPI Specification 3.
Home-page: https://github.com/NotJustAToy/falcon-heavy
Author: Not Just A Toy Corp.
Author-email: dev@notjustatoy.com
License: Apache License 2.0
Keywords: openapi oas oas3
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Communications
Classifier: Topic :: Internet
Requires-Python: >=3.6.0
Requires-Dist: PyYAML>=3.12
Requires-Dist: strict-rfc3339==0.7
Requires-Dist: rfc3339==6.0
Requires-Dist: rfc3987==1.3.7
Requires-Dist: python-mimeparse>=1.5.2
Requires-Dist: wrapt==1.10.11
Requires-Dist: cachetools==3.1.0
Requires-Dist: mypy>=0.711
Requires-Dist: mypy-extensions>=0.4.1
Provides-Extra: django
Requires-Dist: Django>=2.1.0; extra == "django"
Provides-Extra: falcon
Requires-Dist: falcon>=2.0.0; extra == "falcon"
Provides-Extra: flask
Requires-Dist: Flask>=1.1.0; extra == "flask"

************
Falcon Heavy
************


About
#####

The framework for building app backends and microservices by specification-first API design approach based on the `OpenAPI Specification 3 <https://github.com/OAI/OpenAPI-Specification>`__.

Falcon Heavy converts and validates requests and renders responses corresponded specification. It can be used with `Django <https://www.djangoproject.com/>`__, `Falcon <https://falconframework.org/>`__ and `Flask <https://palletsprojects.com/p/flask/>`__ web frameworks.

Installation
############

Recommended way (via pip):

.. code:: bash

    $ pip install falcon-heavy

Usage
#####

1. Implement all abstract methods from a corresponding decorator class.
2. Set up routing based on a specification.
3. Decorate views with your decorator.

Limitations
###########

* XML is not supported.
* Can't use reserved characters in path and query parameters.
* Recursive dependencies detection not implemented.

License
#######

Copyright 2019-2020 Not Just A Toy Corp.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
