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-hypernode.com/pypi/bravado-core/ :alt: PyPi version
.. image:: https://img.shields.io/pypi/pyversions/bravado_core.svg :target: https://pypi-hypernode.com/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
- Fork it ( http://github.com/Yelp/bravado-core/fork )
- Create your feature branch (
git checkout -b my-new-feature) - Add your modifications
- Add short summary of your modifications on
CHANGELOG.rst - Commit your changes (
git commit -m "Add some feature") - Push to the branch (
git push origin my-new-feature) - 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>__.
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
File details
Details for the file bravado-core-6.1.1.tar.gz.
File metadata
- Download URL: bravado-core-6.1.1.tar.gz
- Upload date:
- Size: 63.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/4.0.2 CPython/3.11.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 8cf1f7bbac2f7c696d37e970253938b5be4ddec92c8d5e64400b17469c3714b4 |
|
| MD5 | 050011bd83539ef9a17d544c48fe4625 |
|
| BLAKE2b-256 | ca6d1ffa5c64533bc2fa436afdb9ef287cb0c0d443ef1e84db0601b0af7ce6f5 |
