https://github.com/Yelp/bravado-core

https://github.com/Yelp/bravado-core

openapi python

Last synced: 23 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/Yelp/bravado-core
• Owner: Yelp
• License: other
• Created: 2015-03-30T20:23:27.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2024-05-02T17:48:51.000Z (7 months ago)
• Last Synced: 2024-11-01T11:37:40.886Z (about 1 month ago)
• Topics: openapi, python
• Language: Python
• Homepage:
• Size: 1.98 MB
• Stars: 109
• Watchers: 22
• Forks: 98
• Open Issues: 48
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • License: LICENSE.txt

Awesome Lists containing this project

• starred-awesome - bravado-core - (Python)

README

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

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

Related Projects

----------------

* `bravado `__

* `pyramid-swagger `__

* `swagger-spec-validator `__

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/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 `__.