Skip to main content

A library for dealing with OpenAPI v3 specifications in Python

Project description

.. |travis-ci| image:: https://img.shields.io/travis/pinntech/oas3/master.svg?style=flat-square
:target: https://travis-ci.org/#!/pinntech/oas3?branch=master
.. |coveralls| image:: https://img.shields.io/coveralls/pinntech/oas3/master.svg?style=flat-square
:target: https://coveralls.io/r/pinntech/oas3?branch=master
.. |pypi| image:: https://img.shields.io/pypi/v/oas3.svg?style=flat-square
:target: https://pypi.python.org/pypi/oas3
.. |license| image:: https://img.shields.io/pypi/l/oas3.svg?style=flat-square
:target: https://pypi.python.org/pypi/oas3

****
OAS3
****
|travis-ci| |coveralls| |pypi| |license|

OAS3 is a parser, validator and compiler for dealing with Open API
Specification v3. This library provides an interface for working with
specifications, and loading and dumping to various locations and formats.

Quickstart
===========

To get started load your spec, it will be validated upon dumping.

.. code-block:: python

from oas3 import Spec

# Load the Spec from a file
spec = Spec.from_file('./spec.json')
spec = Spec.from_file('./spec.yml')

# Load the Spec from a URL
spec = Spec.from_url('https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml')

# Load the Spec from a python native dictionary
spec = Spec.from_dict(spec_dict)

# A spec that is sufficiently loaded (i.e. valid OAS3) can now be dumped
spec.to_file('/tmp/spec.yaml')
spec.to_dict()
spec.to_json()
spec.to_yaml()
0.1.0 2018-10-01
----------------

- Pre-alpha release

Project details


Download files

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

Source Distribution

oas3-0.1.13.tar.gz (64.7 kB view details)

Uploaded Source

Built Distribution

oas3-0.1.13-py3.7.egg (19.4 kB view details)

Uploaded Source

File details

Details for the file oas3-0.1.13.tar.gz.

File metadata

  • Download URL: oas3-0.1.13.tar.gz
  • Upload date:
  • Size: 64.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Python-urllib/3.7

File hashes

Hashes for oas3-0.1.13.tar.gz
Algorithm Hash digest
SHA256 58bf01ea537ceff940503c7babc542e2757a67ffbebde5da4635197042008f1f
MD5 4ab1b0c650b18a555dd743923d2924bf
BLAKE2b-256 8910e880480c797a6b0672ee8fef49d8fccbe962048b4b4ee6cd8bdb7122bf33

See more details on using hashes here.

File details

Details for the file oas3-0.1.13-py3.7.egg.

File metadata

  • Download URL: oas3-0.1.13-py3.7.egg
  • Upload date:
  • Size: 19.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Python-urllib/3.7

File hashes

Hashes for oas3-0.1.13-py3.7.egg
Algorithm Hash digest
SHA256 b1a73404bee3fbfbfd185532a5722b078648b7adb63f2b66774d9c30117a451a
MD5 9b08c2c76ae6e5185468a8c98a4e2200
BLAKE2b-256 ed67d594761e09c6cfffa1c3608bcd0c34dae8275aacfb50c759da30ee5b8ce6

See more details on using hashes here.

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