bravado-core


Namebravado-core JSON
Version 6.1.1 PyPI version JSON
download
home_pagehttps://github.com/Yelp/bravado-core
SummaryLibrary for adding Swagger support to clients and servers
upload_time2023-12-14 22:27:42
maintainer
docs_urlNone
authorDigium, Inc. and Yelp, Inc.
requires_python>=3.7
licenseBSD 3-Clause License
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            .. 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>`__.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Yelp/bravado-core",
    "name": "bravado-core",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "",
    "author": "Digium, Inc. and Yelp, Inc.",
    "author_email": "opensource+bravado-core@yelp.com",
    "download_url": "https://files.pythonhosted.org/packages/ca/6d/1ffa5c64533bc2fa436afdb9ef287cb0c0d443ef1e84db0601b0af7ce6f5/bravado-core-6.1.1.tar.gz",
    "platform": null,
    "description": ".. image:: https://github.com/Yelp/bravado-core/workflows/build/badge.svg?branch=master\n  :target: https://github.com/Yelp/bravado-core/actions?query=workflow%3Abuild\n\n.. image:: https://img.shields.io/coveralls/Yelp/bravado-core.svg\n  :target: https://coveralls.io/r/Yelp/bravado-core\n\n.. image:: https://img.shields.io/pypi/v/bravado-core.svg\n    :target: https://pypi.python.org/pypi/bravado-core/\n    :alt: PyPi version\n\n.. image:: https://img.shields.io/pypi/pyversions/bravado_core.svg\n    :target: https://pypi.python.org/pypi/bravado-core/\n    :alt: Supported Python versions\n\nbravado-core\n============\n\nAbout\n-----\n\nbravado-core is a Python library that adds client-side and server-side support\nfor the `OpenAPI Specification v2.0 <https://github.com/OAI/OpenAPI-Specification>`__.\n\nFeatures\n--------\n* OpenAPI Specification schema validation\n* Marshaling, transformation, and validation of requests and responses\n* Models as Python classes or dicts\n* Custom formats for type conversion\n\nDocumentation\n-------------\n\nDocumentation is available at `readthedocs.org <http://bravado-core.readthedocs.org>`__\n\n\nInstallation\n------------\n\n::\n\n    $ pip install bravado-core\n\n\nRelated Projects\n----------------\n* `bravado <https://github.com/Yelp/bravado>`__\n* `pyramid-swagger <https://github.com/striglia/pyramid_swagger>`__\n* `swagger-spec-validator <https://github.com/Yelp/swagger_spec_validator>`__\n\nDevelopment\n===========\n\n| Code is documented using `Sphinx <http://sphinx-doc.org/>`__.\n| `virtualenv <http://virtualenv.readthedocs.org/en/latest/virtualenv.html>`__ is recommended to keep dependencies and libraries isolated.\n| `tox <https://tox.readthedocs.org/en/latest/>`__ is used for standardized testing.\n\nSetup\n-----\n\n::\n\n    # Run tests\n    tox\n\n    # Install git pre-commit hooks\n    .tox/py310/bin/pre-commit install\n\n\nContributing\n------------\n\n1. Fork it ( http://github.com/Yelp/bravado-core/fork )\n2. Create your feature branch (``git checkout -b my-new-feature``)\n3. Add your modifications\n4. Add short summary of your modifications on ``CHANGELOG.rst``\n5. Commit your changes (``git commit -m \"Add some feature\"``)\n6. Push to the branch (``git push origin my-new-feature``)\n7. Create new Pull Request\n\nLicense\n-------\n\n| Copyright (c) 2013, Digium, Inc. All rights reserved.\n| Copyright (c) 2014-2015, Yelp, Inc. All rights reserved.\n\nBravado is licensed with a `BSD 3-Clause\nLicense <http://opensource.org/licenses/BSD-3-Clause>`__.\n",
    "bugtrack_url": null,
    "license": "BSD 3-Clause License",
    "summary": "Library for adding Swagger support to clients and servers",
    "version": "6.1.1",
    "project_urls": {
        "Homepage": "https://github.com/Yelp/bravado-core"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ca6d1ffa5c64533bc2fa436afdb9ef287cb0c0d443ef1e84db0601b0af7ce6f5",
                "md5": "050011bd83539ef9a17d544c48fe4625",
                "sha256": "8cf1f7bbac2f7c696d37e970253938b5be4ddec92c8d5e64400b17469c3714b4"
            },
            "downloads": -1,
            "filename": "bravado-core-6.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "050011bd83539ef9a17d544c48fe4625",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 63851,
            "upload_time": "2023-12-14T22:27:42",
            "upload_time_iso_8601": "2023-12-14T22:27:42.168149Z",
            "url": "https://files.pythonhosted.org/packages/ca/6d/1ffa5c64533bc2fa436afdb9ef287cb0c0d443ef1e84db0601b0af7ce6f5/bravado-core-6.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-12-14 22:27:42",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Yelp",
    "github_project": "bravado-core",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "tox": true,
    "lcname": "bravado-core"
}
        
Elapsed time: 0.15273s