Skip to main content
2025 Python Packaging Survey is now live!  Take the survey now

Library for adding Swagger support to clients and servers

Project description

https://img.shields.io/travis/Yelp/bravado-core.svg https://img.shields.io/coveralls/Yelp/bravado-core.svg PyPi version Supported Python versions

bravado-core

About

bravado-core is a Python library that adds client-side and server-side support for the OpenAPI Specification v2.0.

Features

  • OpenAPI Specification schema validation

  • Marshaling, transformation, and validation of requests and responses

  • Models as Python classes or dicts

  • Custom formats for type conversion

Documentation

Documentation is available at readthedocs.org

Installation

$ pip install bravado-core

Development

Code is documented using Sphinx.
virtualenv is recommended to keep dependencies and libraries isolated.
tox is used for standardized testing.

Setup

# Run tests
tox

# Install git pre-commit hooks
.tox/py27/bin/pre-commit install

Contributing

  1. Fork it ( http://github.com/Yelp/bravado-core/fork )

  2. Create your feature branch (git checkout -b my-new-feature)

  3. Add your modifications

  4. Add short summary of your modifications on CHANGELOG.rst

  5. Commit your changes (git commit -m "Add some feature")

  6. Push to the branch (git push origin my-new-feature)

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

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page