Metadata-Version: 2.1
Name: pyramid_openapi3
Version: 0.7.0
Summary: Pyramid addon for OpenAPI3 validation
Home-page: https://github.com/Pylons/pyramid_openapi3
Author: niteo.co
Author-email: info@niteo.co
License: MIT
Description: ## Validate [Pyramid](https://trypyramid.com) views against an [OpenAPI 3.0](https://swagger.io/specification/) document
        
        <p align="center">
          <img height="200" src="https://github.com/Pylons/pyramid_openapi3/blob/master/header.jpg?raw=true" />
        </p>
        
        <p align="center">
          <a href="https://circleci.com/gh/Pylons/pyramid_openapi3">
            <img alt="CircleCI for pyramid_openapi3 (master branch)"
                 src="https://circleci.com/gh/Pylons/pyramid_openapi3.svg?style=shield">
          </a>
          <img alt="Test coverage (master branch)"
               src="https://img.shields.io/badge/tests_coverage-100%25-brightgreen.svg">
          <img alt="Test coverage (master branch)"
               src="https://img.shields.io/badge/types_coverage-100%25-brightgreen.svg">
          <a href="https://pypi.org/project/pyramid_openapi3/">
            <img alt="latest version of pyramid_openapi3 on PyPI"
                 src="https://img.shields.io/pypi/v/pyramid_openapi3.svg">
          </a>
          <a href="https://pypi.org/project/pyramid_openapi3/">
            <img alt="Supported Python versions"
                 src="https://img.shields.io/pypi/pyversions/pyramid_openapi3.svg">
          </a>
          <a href="https://github.com/Pylons/pyramid_openapi3/blob/master/LICENSE">
            <img alt="License: MIT"
                 src="https://img.shields.io/badge/License-MIT-yellow.svg">
          </a>
          <a href="https://github.com/Pylons/pyramid_openapi3/graphs/contributors">
            <img alt="Built by these great folks!"
                 src="https://img.shields.io/github/contributors/Pylons/pyramid_openapi3.svg">
          </a>
          <a href="https://webchat.freenode.net/?channels=pyramid">
            <img alt="Talk to us in #pyramid on Freenode IRC"
                 src="https://img.shields.io/badge/irc-freenode-blue.svg">
          </a>
        </p>
        
        ## Peace of Mind
        
        The reason this package exists is to give you peace of mind when providing a RESTful API. Instead of chasing down preventable bugs and saying sorry to consumers, you can focus on more important things in life.
        
        - Your **API documentation is never out-of-date**, since it is generated out of the API document that you write.
        - The documentation comes with **_try-it-out_ examples** for every endpoint in your API. You don't have to provide (and maintain) `curl` commands to showcase how your API works. Users can try it themselves, right in their browsers.
        - Your **API document is always valid**, since your Pyramid app won't even start if the document is not according to OpenAPI 3.0 specification.
        - Automatic request **payload validation and sanitization**. Your views do not require any code for validation and input sanitation. Your view code only deals with business logic. Tons of tests never need to be written since every request, and its payload, is validated against your API document before it reaches your view code.
        - Your API **responses always match your API document**. Every response from your view is validated against your document and a `500 Internal Server Error` is returned if the response does not exactly match what your document says the output of a certain API endpoint should be. This decreases the effects of the [Hyrum's Law](https://www.hyrumslaw.com).
        - **A single source of truth**. Because of the checks outlined above you can be sure that whatever your API document says is in fact what is going on in reality. You have a single source of truth to consult when asking an API related question, such as "Remind me again, which fields does the endpoint /user/info return?".
        - Based on [Pyramid](https://trypyramid.com), a **mature Python Web framework**. Companies such as Mozilla, Yelp, RollBar and SurveyMonkey [trust Pyramid](https://trypyramid.com/community-powered-by-pyramid.html), and the new [pypi.org](https://github.com/pypa/warehouse) runs on Pyramid too. Pyramid is thoroughly [tested](https://travis-ci.org/Pylons/pyramid) and [documented](http://docs.pylonsproject.org/projects/pyramid/en/latest/), providing flexibility, performance, and a large ecosystem of [high-quality add-ons](https://trypyramid.com/extending-pyramid.html).
        
        ## Features
        
        - Validates your API document (for example, `openapi.yaml` or `openapi.json`) against the OpenAPI 3.0 specification using the [openapi-spec-validator](https://github.com/p1c2u/openapi-spec-validator).
        - Generates and serves the [Swagger try-it-out documentation](https://swagger.io/tools/swagger-ui/) for your API.
        - Validates incoming requests *and* outgoing responses against your API document using [openapi-core](https://github.com/p1c2u/openapi-core).
        
        
        ## Getting started
        
        1. Declare `pyramid_openapi3` as a dependency in your Pyramid project.
        
        2. Include the following lines:
        
        ```python
        config.include("pyramid_openapi3")
        config.pyramid_openapi3_spec('openapi.yaml', route='/api/v1/openapi.yaml')
        config.pyramid_openapi3_add_explorer(route='/api/v1/')
        ```
        
        3. Use the `openapi` [view predicate](https://docs.pylonsproject.org/projects/pyramid/en/latest/narr/viewconfig.html#view-configuration-parameters) to enable request/response validation:
        
        ```python
        @view_config(route_name="foobar", openapi=True, renderer='json')
        def myview(request):
            return request.openapi_validated.parameters
        ```
        
        For requests, `request.openapi_validated` is available with two fields: `parameters` and `body`.
        For responses, if the payload does not match the API document, an exception is raised.
        
        
        ## Demo / Examples
        
        There are two examples provided with this package:
        * A fairly simple [single-file app providing a Hello World API](https://github.com/Pylons/pyramid_openapi3/tree/master/examples/singlefile).
        * A slightly more [built-out app providing a TODO app API](https://github.com/Pylons/pyramid_openapi3/tree/master/examples/todoapp).
        
        Both examples come with tests that exhibit pyramid_openapi's error handling and validation capabilities.
        
        A **fully built-out app**, with 100% test coverage, providing a [RealWorld.io](https://realworld.io) API is available at [niteoweb/pyramid-realworld-example-app](https://github.com/niteoweb/pyramid-realworld-example-app). It is a Heroku-deployable Pyramid app that provides an API for a Medium.com-like social app. You are encouraged to use it as a scaffold for your next project.
        
        
        ## Design defense
        
        The authors of pyramid_openapi3 believe that the approach of validating a manually-written API document is superior to the approach of generating the API document from Python code. Here are the reasons:
        
        a) Both generation and validation against a document are lossy processes. The underlying libraries running the generation/validation will always have something missing. Either a feature from the latest OpenAPI specification, or an implementation bug. Having to fork the underlying library in order to generate the part of your API document that might only be needed for the frontend is unfortunate.
        
           Validation on the other hand allows one to skip parts of validation that are not supported yet, and not block a team from shipping the document.
        
        b) Validation approach does sacrifice DRY-ness, one has to write the API document and then the (view) code in Pyramid. Feels a bit redundant at first. However, this provides a clear separation between the intent and the implementation.
        
        c) Generation approach has the drawback of having to write Python code even for parts of the API document that the Pyramid backend does not handle, as it might be handled by a different system, or be specific only to documentation or only to the client side of the API. This bloats your Pyramid codebase with code that does not belong there.
        
        ## Running tests
        
        You need to have [pipenv](https://pipenv.readthedocs.io/) and Python 3.7 or 3.8 installed on your machine. Then you can run:
        
            $ make tests
        
        ## Related packages
        
        These packages tackle the same problem-space:
        
        - [pyramid_oas3](https://github.com/kazuki/pyramid-oas3) seems to do things very similarly to pyramid_openapi3, but the documentation is not in English and we sadly can't fully understand what it does just reading the code.
        - [pyramid_swagger](https://github.com/striglia/pyramid_swagger) does a similar
          thing, but for Swagger 2.0 documents.
        - [connexion](https://github.com/zalando/connexion) takes the same "write spec first, code second" approach as pyramid_openapi3, but is based on Flask.
        - [bottle-swagger](https://github.com/ampedandwired/bottle-swagger) takes the same "write spec first, code second" approach too, but is based on Bottle.
        - [pyramid_apispec](https://github.com/ergo/pyramid_apispec) uses generation with
          help of apispec and marshmallow validation library. See above [why we prefer validation instead of generation](#design-defense).
        
        ## Deprecation policy
        
        We do our best to follow the rules below.
        
        * Support the latest two releases of Python, currently Python 3.7 and 3.8.
        * Support only a single release of `openapi-core` and its sub-dependencies. See `Pipfile.lock` for a frozen-in-time known-good-set of all dependencies.
        
        ## Use in the wild
        
        A couple of projects that use pyramid_openapi3 in production:
        
        - [WooCart API](https://app.woocart.com/api/v1/) - User control panel for WooCart Managed WooCommerce service.
        - [Kafkai API](https://app.kafkai.com/api/v1) - User control panel for Kafkai text generation service.
        
        
        ## Changelog
        
        0.7.0 (2020-04-03)
        ------------------
        
        * Better support for handling apps mounted at subpaths.
          [mmerickel]
        
        * Pass the response into the response validation exception to support use-cases
          where we can return the response but log the errors.
          [mmerickel]
        
        * Reload development server also when YAML file changes.
          [mmerickel]
        
        
        0.6.0 (2020-03-19)
        ------------------
        
        * Better support for custom formatters and a test showcasing how to use them.
          [zupo]
        
        
        0.5.2 (2020-03-16)
        ------------------
        
        * Bad JWT tokens should result in 401 instead of 400.
          [zupo]
        
        
        0.5.1 (2020-03-13)
        ------------------
        
        * Fix a regression with relative `servers` entries in `openapi.yaml`.
          Refs https://github.com/p1c2u/openapi-core/issues/218.
          [zupo]
        
        
        0.5.0 (2020-03-07)
        ------------------
        
        * [BREAKING CHANGE] Move `openapi_validation_error` from `examples/todoapp`
          into the main package so it becomes a first-class citizen and people can use
          it without copy/pasting. If you need custom JSON rendering, you can provide
          your own `extract_errors` function via `pyramid_openapi3_extract_errors`
          config setting.
          [zupo]
        
        * Upgrade `openapi-core` to `0.13.x` which brings a complete rewrite of the
          validation mechanism that is now based on `jsonschema` library. This
          manifests as different validation error messages.
        
          [BREAKING CHANGE] By default, `openapi-core` no longer creates models
          from validated data, but returns `dict`s. More info on
          https://github.com/p1c2u/openapi-core/issues/205
          [zupo]
        
        
        0.4.1 (2019-10-22)
        ------------------
        
        * Pin openapi-core dependency to a sub 0.12.0 version, to avoid
          regressions with validation. Details on
          https://github.com/p1c2u/openapi-core/issues/160
          [zupo]
        
        
        0.4.0 (2019-08-05)
        ------------------
        
        * Fix handling parameters in Headers and Cookies. [gweis]
        
        * Introduce RequestValidationError and ResponseValidationError exceptions
          in favor of pyramid_openapi3_validation_error_view directive.
          [gweis]
        
        
        0.3.0 (2019-05-22)
        ------------------
        
        * Added type hints. [zupo]
        * Added additional references to other packages covering the same problem-space. [zupo]
        * Moved repo to Pylons GitHub organization. [stevepiercy, zupo]
        * Added a more built-out TODO-app example. [zupo]
        
        
        0.2.8 (2019-04-17)
        ------------------
        
        * Fix for double-registering views. [zupo]
        * Added a single-file example. [zupo]
        
        
        0.2.7 (2019-04-14)
        ------------------
        
        * Tweaking the release process. [zupo]
        
        
        0.2.6 (2019-04-14)
        ------------------
        
        * Added a bunch of tests. [zupo]
        
        
        0.2.5 (2019-04-08)
        ------------------
        
        * Automatic releases via CircleCI. [zupo]
        
        
        0.1.0 (2019-04-08)
        ------------------
        
        * Initial release. [zupo]
        
Keywords: pyramid openapi3 openapi rest restful
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Framework :: Pyramid
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Description-Content-Type: text/markdown
