Metadata-Version: 2.1
Name: bravado
Version: 10.6.1
Summary: Library for accessing Swagger-enabled API's
Home-page: https://github.com/Yelp/bravado
Author: Digium, Inc. and Yelp, Inc.
Author-email: opensource+bravado@yelp.com
License: BSD 3-Clause License
Description: .. image:: https://img.shields.io/travis/Yelp/bravado.svg
          :target: https://travis-ci.org/Yelp/bravado?branch=master
        
        .. image:: https://img.shields.io/coveralls/Yelp/bravado.svg
          :target: https://coveralls.io/r/Yelp/bravado
        
        .. image:: https://img.shields.io/pypi/v/bravado.svg
            :target: https://pypi.python.org/pypi/bravado/
            :alt: PyPi version
        
        .. image:: https://img.shields.io/pypi/pyversions/bravado.svg
            :target: https://pypi.python.org/pypi/bravado/
            :alt: Supported Python versions
        
        Bravado
        ==========
        
        About
        -----
        
        Bravado is a Yelp maintained fork of `digium/swagger-py <https://github.com/digium/swagger-py/>`__
        for use with `OpenAPI Specification version 2.0 <https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md>`__ (previously
        known as Swagger).
        
        From the OpenAPI Specification project:
        
            The goal of The OpenAPI Specification is to define a standard,
            language-agnostic interface to REST APIs which allows both humans and
            computers to discover and understand the capabilities of the service
            without access to source code, documentation, or through network traffic
            inspection.
        
        Client libraries can automatically be generated from the OpenAPI specification,
        however Bravado aims to be a complete replacement for code generation
        (`swagger-codegen <https://github.com/wordnik/swagger-codegen>`__).
        
        Example Usage
        -------------
        
        .. code-block:: Python
        
            from bravado.client import SwaggerClient
            client = SwaggerClient.from_url('http://petstore.swagger.io/v2/swagger.json')
            pet = client.pet.getPetById(petId=1).response().result
        
        Example with Basic Authentication
        ---------------------------------
        
        .. code-block:: python
        
            from bravado.requests_client import RequestsClient
            from bravado.client import SwaggerClient
        
            http_client = RequestsClient()
            http_client.set_basic_auth(
                'api.yourhost.com',
                'username', 'password'
            )
            client = SwaggerClient.from_url(
                'http://petstore.swagger.io/v2/swagger.json',
                http_client=http_client,
            )
            pet = client.pet.getPetById(petId=1).response().result
        
        Example with Header Authentication
        ----------------------------------
        
        .. code-block:: python
        
            from bravado.requests_client import RequestsClient
            from bravado.client import SwaggerClient
        
            http_client = RequestsClient()
            http_client.set_api_key(
                'api.yourhost.com', 'token',
                param_name='api_key', param_in='header'
            )
            client = SwaggerClient.from_url(
                'http://petstore.swagger.io/v2/swagger.json',
                http_client=http_client,
            )
            pet = client.pet.getPetById(petId=1).response().result
        
        Example with Fido Client (Async Http Client)
        --------------------------------------------
        
        .. code-block:: python
        
            # Install bravado with fido extra (``pip install bravado[fido]``)
            from bravado.fido_client import FidoClient
            from bravado.client import SwaggerClient
        
            http_client = FidoClient()
            client = SwaggerClient.from_url(
                'http://petstore.swagger.io/v2/swagger.json',
                http_client=http_client,
            )
            pet = client.pet.getPetById(petId=1).response().result
        
        Documentation
        -------------
        
        More documentation is available at http://bravado.readthedocs.org
        
        Installation
        ------------
        
        .. code-block:: bash
        
            # To install bravado with Synchronous Http Client only.
            $ pip install bravado
        
            # To install bravado with Synchronous and Asynchronous Http Client (RequestsClient and FidoClient).
            $ pip install bravado[fido]
        
        Development
        ===========
        
        Code is documented using `Sphinx <http://sphinx-doc.org/>`__.
        
        `virtualenv <https://virtualenv.readthedocs.io/en/latest/>`__. is
        recommended to keep dependencies and libraries isolated.
        
        Setup
        -----
        
        .. code-block:: bash
        
            # Run tests
            tox
        
            # Install git pre-commit hooks
            tox -e pre-commit install
        
        Contributing
        ------------
        
        1. Fork it ( http://github.com/Yelp/bravado/fork )
        2. Create your feature branch (``git checkout -b my-new-feature``)
        3. Add your modifications
        4. Commit your changes (``git commit -m "Add some feature"``)
        5. Push to the branch (``git push origin my-new-feature``)
        6. Create new Pull Request
        
        License
        -------
        
        Copyright (c) 2013, Digium, Inc. All rights reserved.
        Copyright (c) 2014-2015, Yelp, Inc. All rights reserved.
        
        Bravado is licensed with a `BSD 3-Clause
        License <http://opensource.org/licenses/BSD-3-Clause>`__.
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires-Python: !=3.0,!=3.1,!=3.2,!=3.3,!=3.4,!=3.5.0
Provides-Extra: fido
Provides-Extra: integration-tests
