bravado

Library for accessing Swagger-enabled API's

These details have not been verified by PyPI

Project links

Homepage

Project description

https://img.shields.io/travis/Yelp/bravado.svg

https://img.shields.io/coveralls/Yelp/bravado.svg

Bravado

About

Bravado is a Yelp maintained fork of digium/swagger-py for use with OpenAPI Specification version 2.0 (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).

Example Usage

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

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

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)

# 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

# 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.

virtualenv. is recommended to keep dependencies and libraries isolated.

Setup

# Run tests
tox

# Install git pre-commit hooks
tox -e pre-commit install

Contributing

Fork it ( http://github.com/Yelp/bravado/fork )
Create your feature branch (git checkout -b my-new-feature)
Add your modifications
Commit your changes (git commit -m "Add some feature")
Push to the branch (git push origin my-new-feature)
Create new Pull Request

License

Bravado is licensed with a BSD 3-Clause License.

Project details

These details have not been verified by PyPI

Project links

Homepage

Release history Release notifications | RSS feed

11.0.3

Mar 2, 2021

11.0.2

Oct 27, 2020

11.0.1

Oct 5, 2020

10.6.3

Sep 29, 2020

10.6.2

May 26, 2020

10.6.1

May 22, 2020

This version

10.6.0

Mar 30, 2020

10.5.0

Feb 24, 2020

10.4.3

Nov 4, 2019

10.4.2

Oct 16, 2019

10.4.1

May 8, 2019

10.4.0

May 7, 2019

10.3.2

Mar 25, 2019

10.3.1

Feb 27, 2019

10.3.0

Feb 20, 2019

10.2.2

Jan 3, 2019

10.2.1

Nov 16, 2018

10.2.0

Oct 19, 2018

10.1.0

Jun 26, 2018

10.0.1

Jun 20, 2018

10.0.0

Jun 15, 2018

9.3.2

Jun 15, 2018

9.3.1

Jun 14, 2018

9.3.0

Jun 4, 2018

9.2.2

Dec 19, 2017

9.2.1

Dec 7, 2017

9.2.0

Nov 10, 2017

9.1.1

Oct 10, 2017

9.1.0

Aug 2, 2017

9.0.7

Jul 5, 2017

9.0.6

Jun 28, 2017

9.0.5

Jun 23, 2017

9.0.4

Jun 22, 2017

9.0.3

Jun 21, 2017

9.0.2

Jun 12, 2017

9.0.1

Jun 9, 2017

9.0.0

Jun 6, 2017

8.4.0

Sep 27, 2016

8.3.0

Jul 28, 2016

8.1.2

Apr 18, 2016

8.1.0

Apr 4, 2016

8.0.1

Dec 2, 2015

8.0.0

Nov 25, 2015

7.0.0

Oct 23, 2015

6.1.1

Oct 19, 2015

6.1.0

Oct 19, 2015

6.0.0

Oct 12, 2015

5.0.0

Aug 27, 2015

4.0.0

Aug 10, 2015

3.0.0

Aug 3, 2015

2.1.0

Jul 20, 2015

2.0.0

Jul 14, 2015

1.0.0

Jun 25, 2015

1.0.0-rc2 pre-release

Jun 2, 2015

1.0.0-rc1 pre-release

May 14, 2015

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bravado-10.6.0.tar.gz (37.0 kB view details)

Uploaded Mar 30, 2020 Source

Built Distribution

bravado-10.6.0-py2.py3-none-any.whl (37.2 kB view details)

Uploaded Mar 30, 2020 Python 2 Python 3

File details

Details for the file bravado-10.6.0.tar.gz.

File metadata

Download URL: bravado-10.6.0.tar.gz
Upload date: Mar 30, 2020
Size: 37.0 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.44.1 CPython/3.8.1

File hashes

Hashes for bravado-10.6.0.tar.gz
Algorithm	Hash digest
SHA256	`f1e81041f1e48478cce4e6805d57572b29ad2cf3187aae393c4eb3a2b8a053c2`
MD5	`7ee412595e8d3aac137a673150642a1e`
BLAKE2b-256	`7529a177ed87e54987aa9a973711953023048d295d00c660ed4e0b7ad7c5abc5`

See more details on using hashes here.

File details

Details for the file bravado-10.6.0-py2.py3-none-any.whl.

File metadata

Download URL: bravado-10.6.0-py2.py3-none-any.whl
Upload date: Mar 30, 2020
Size: 37.2 kB
Tags: Python 2, Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.44.1 CPython/3.8.1

File hashes

Hashes for bravado-10.6.0-py2.py3-none-any.whl
Algorithm	Hash digest
SHA256	`bc4c5efed34acd903ea65901b3acda06f3490484447d26d2a9146b2c9cd589aa`
MD5	`3a07d2ab622e9c439a1f480397722e35`
BLAKE2b-256	`8645f94d58c84ec3ee44c1badb2d9ae5468c6575eafe33116afaa07ea2fd663c`