Metadata-Version: 2.1
Name: portal-openapi-client
Version: 0.1.1
Summary: UNKNOWN
Home-page: UNKNOWN
Author: OpenAPI Generator community
Author-email: team@openapitools.org
License: UNKNOWN
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](https://openapi-generator.tech) 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:
        
        ```sh
        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:
        ```python
        import openapi_client
        ```
        
        ### Setuptools
        
        Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
        
        ```sh
        python setup.py install --user
        ```
        (or `sudo python setup.py install` to install the package for all users)
        
        Then import the package:
        ```python
        import openapi_client
        ```
        
        ## Getting Started
        
        Please follow the [installation procedure](#installation--usage) and then run the following:
        
        ```python
        
        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**](docs/CompaniesApi.md#companies_list) | **GET** /api/companies/ | 
        *CompaniesApi* | [**companies_read**](docs/CompaniesApi.md#companies_read) | **GET** /api/companies/{id}/ | 
        *MachinesApi* | [**machines_list**](docs/MachinesApi.md#machines_list) | **GET** /api/machines/ | 
        *MachinesApi* | [**machines_read**](docs/MachinesApi.md#machines_read) | **GET** /api/machines/{id}/ | 
        *TelemetryApi* | [**telemetry_list**](docs/TelemetryApi.md#telemetry_list) | **GET** /api/telemetry/ | 
        *TelemetryApi* | [**telemetry_read**](docs/TelemetryApi.md#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 *
        ```
        
        
Keywords: OpenAPI,OpenAPI-Generator,
Platform: UNKNOWN
Requires-Python: >=3.6
Description-Content-Type: text/markdown
