Skip to main content

The OpenAPI Artifact Generator Python Package

Project description

OpenAPIArt

license Project Status: Active – The project has reached a stable, usable state and is being actively developed. CICD pypi python

The OpenAPIArt (OpenAPI Artifact Generator) python package does the following:

  • bundles individual yaml files into a single file
  • post process x- extensions
  • validates the bundled openapi.yaml file
  • creates an enhanced ux python file containing all the classes generated from the bundled openapi.yaml file

This python package DOES NOT create a python package for the generated artifacts.

Getting started

Install the package

pip install openapiart

Generate artifacts from OpenAPI models

import openapiart

# the following command produces these artifacts
# openapi.yaml
# openapi.json
# openapi.html
# test.py
openapiart.OpenApiArt(api_files=['./tests/api/api.yaml'], python_module_name='sample')

Specifications

This repository is based on the OpenAPI specification which is a standard, language-agnostic interface to RESTful APIs.

Modeling guide specific to this package

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

openapiart-0.0.8.tar.gz (19.8 kB view details)

Uploaded Source

Built Distribution

openapiart-0.0.8-py2.py3-none-any.whl (21.3 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file openapiart-0.0.8.tar.gz.

File metadata

  • Download URL: openapiart-0.0.8.tar.gz
  • Upload date:
  • Size: 19.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.4

File hashes

Hashes for openapiart-0.0.8.tar.gz
Algorithm Hash digest
SHA256 ef2428b092440d36d9c0697902e1d63eb2934c33288fdd826c00ad95d6f6b9d5
MD5 22d34b4d85ca0563840c726bd095e3fb
BLAKE2b-256 f3efaf6ae58490e15327995a419ee38c08c469f7aaf4cb8dc8379851f3858b3d

See more details on using hashes here.

File details

Details for the file openapiart-0.0.8-py2.py3-none-any.whl.

File metadata

  • Download URL: openapiart-0.0.8-py2.py3-none-any.whl
  • Upload date:
  • Size: 21.3 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.4

File hashes

Hashes for openapiart-0.0.8-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 03c6df4a3b8b59bcc43c98229b0e837a9cf29b31c15d47cf1815f609d90d2392
MD5 2dd0b6cc5edc83ada28611f7da82a592
BLAKE2b-256 1865b12a4e3cf5764416c94f36216be36412cdc44af8662d5082c15a7d9ed263

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