No project description provided
Project description
portal-openapi-client
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 1.0.0
- Package version: 0.1.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
Requirements.
Python >= 3.6
Installation & Usage
pip install
If the python package is hosted on a repository, you can install directly using:
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
(you may need to run pip
with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
)
Then import the package:
import openapi_client
Setuptools
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install
to install the package for all users)
Then import the package:
import openapi_client
Getting Started
Please follow the installation procedure and then run the following:
import time
import openapi_client
from pprint import pprint
from openapi_client.api import companies_api
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
host = "http://localhost"
)
# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = companies_api.CompaniesApi(api_client)
try:
api_instance.companies_list()
except openapi_client.ApiException as e:
print("Exception when calling CompaniesApi->companies_list: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to http://localhost
Class | Method | HTTP request | Description |
---|---|---|---|
CompaniesApi | companies_list | GET /api/companies/ | |
CompaniesApi | companies_read | GET /api/companies/{id}/ | |
MachinesApi | machines_list | GET /api/machines/ | |
MachinesApi | machines_read | GET /api/machines/{id}/ | |
TelemetryApi | telemetry_list | GET /api/telemetry/ | |
TelemetryApi | telemetry_read | GET /api/telemetry/{id}/ |
Documentation For Models
Documentation For Authorization
All endpoints do not require authorization.
Author
Notes for Large OpenAPI documents
If the OpenAPI document is large, imports in openapi_client.apis and openapi_client.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:
Solution 1: Use specific imports for apis and models like:
from openapi_client.api.default_api import DefaultApi
from openapi_client.model.pet import Pet
Solution 2: Before importing the package, adjust the maximum recursion limit as shown below:
import sys
sys.setrecursionlimit(1500)
import openapi_client
from openapi_client.apis import *
from openapi_client.models import *
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
Built Distribution
Hashes for portal-openapi-client-0.1.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f4e661c6fcb743c2e136d2f16d5bf2c494c68902cad129bf5bf54a33c96538f9 |
|
MD5 | 61d1c57ceb260c29acf0d3c23f7af42a |
|
BLAKE2b-256 | f5e48325911e14d6c5ebdc8dc29e01078ce44f9741aa5a33cadebae555dc4232 |
Hashes for portal_openapi_client-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8c527503b309e21eb6b35462263998fde51cfba8979acc3ba9afdcfc6e180a54 |
|
MD5 | 4f379010df911bdc6e43577a09b270d7 |
|
BLAKE2b-256 | 5ebc32e4fd99e5311c384103d73c32f537ad36df849384c1946d0eacc025ce2d |