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.0.tar.gz (64.0 kB view details)

Uploaded Source

Built Distribution

bravado_core-6.1.0-py2.py3-none-any.whl (67.7 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file bravado-core-6.1.0.tar.gz.

File metadata

  • Download URL: bravado-core-6.1.0.tar.gz
  • Upload date:
  • Size: 64.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.6

File hashes

Hashes for bravado-core-6.1.0.tar.gz
Algorithm Hash digest
SHA256 1f40afc08ddc9199a2fe9732ea0695fac5fd8b871c10222e9718e8c13f91c88a
MD5 1bd062e4ef69b39307360113ef5c9724
BLAKE2b-256 7e8035639caa83a7e312c892932d74f6ea0d5c24c310197321bb36e07f71ecd7

See more details on using hashes here.

Provenance

File details

Details for the file bravado_core-6.1.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for bravado_core-6.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 e3ac495fca5d475addeae45a2be8a51fd4120416d2183d630f001dfcfcc628dc
MD5 6b3ca0c4a29297d81ff6b7d2038155c4
BLAKE2b-256 5f267fdeaa8b87bbf2a7d05230d4e9f40b232aff4527fe2d582aa8d4d56cee88

See more details on using hashes here.

Provenance

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