connect-python-openapi-client icon indicating copy to clipboard operation
connect-python-openapi-client copied to clipboard

Connect API Client based on the OpenAPI specification for Python 3.6+

Connect Python OpenAPI Client

pyversions PyPi Status Build Status codecov Quality Gate Status

Introduction

Connect Python OpenAPI Client is the simple, concise, powerful and REPL-friendly CloudBlue Connect API client.

It has been designed following the fluent interface design pattern.

Due to its REPL-friendly nature, using the CloudBlue Connect OpenAPI specifications it allows developers to learn and play with the CloudBlue Connect API using a python REPL like jupyter or ipython.

Install

Connect Python OpenAPI Client requires python 3.9 or later.

Connect Python OpenAPI Client can be installed from pypi.org using pip:

$ pip install connect-openapi-client

Development

We use isort library to order and format our imports, and black - to format the code. We check it using flake8-isort and flake8-black libraries (automatically on flake8 run).
For convenience you may run isort . && black . to format the code.

Documentation

Connect Python OpenAPI Client documentation is hosted on the Read the Docs service.

License

Connect Python OpenAPI Client is released under the Apache License Version 2.0.