Skip to main content

Library for adding Swagger support to clients and servers

Project description

.. image:: https://github.com/Yelp/bravado-core/workflows/build/badge.svg?branch=master :target: https://github.com/Yelp/bravado-core/actions?query=workflow%3Abuild

.. image:: https://img.shields.io/coveralls/Yelp/bravado-core.svg :target: https://coveralls.io/r/Yelp/bravado-core

.. image:: https://img.shields.io/pypi/v/bravado-core.svg :target: https://pypi.python.org/pypi/bravado-core/ :alt: PyPi version

.. image:: https://img.shields.io/pypi/pyversions/bravado_core.svg :target: https://pypi.python.org/pypi/bravado-core/ :alt: 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 <https://github.com/OAI/OpenAPI-Specification>__.

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 <http://bravado-core.readthedocs.org>__

Installation

::

$ pip install bravado-core

Related Projects

  • bravado <https://github.com/Yelp/bravado>__
  • pyramid-swagger <https://github.com/striglia/pyramid_swagger>__
  • swagger-spec-validator <https://github.com/Yelp/swagger_spec_validator>__

Development

| Code is documented using Sphinx <http://sphinx-doc.org/>. | virtualenv <http://virtualenv.readthedocs.org/en/latest/virtualenv.html> is recommended to keep dependencies and libraries isolated. | tox <https://tox.readthedocs.org/en/latest/>__ is used for standardized testing.

Setup

::

# Run tests
tox

# Install git pre-commit hooks
.tox/py310/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 <http://opensource.org/licenses/BSD-3-Clause>__.

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

bravado-core-6.1.1.tar.gz (63.9 kB view hashes)

Uploaded Source

Supported by

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