Skip to content

One-Green/og-py-openapi-client

BranchesTags

Repository files navigation

og-client

Plant cultivation framework

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: v1
  • Package version: 1.0.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/One-Green/og-py-openapi-client.git#egg=og_client

(you may need to run pip with root permission: sudo pip install git+https://github.com/One-Green/og-py-openapi-client.git#egg=og_client)

Then import the package:

import og_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 og_client

Getting Started

Please follow the installation procedure and then run the following:

import time
import og_client
from pprint import pprint
from og_client.api import global_api
from og_client.model.global_config import GlobalConfig
from og_client.model.global_config_list200_response import GlobalConfigList200Response
# Defining the host is optional and defaults to http://0.0.0.0:8001
# See configuration.py for a list of all supported configuration parameters.
configuration = og_client.Configuration(
    host = "http://0.0.0.0:8001"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: Basic
configuration = og_client.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)


# Enter a context with an instance of the API client
with og_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = global_api.GlobalApi(api_client)
    data = GlobalConfig(
        site_tag="site_tag_example",
        address="address_example",
        timezone="timezone_example",
    ) # GlobalConfig | 

    try:
        api_response = api_instance.global_config_create(data)
        pprint(api_response)
    except og_client.ApiException as e:
        print("Exception when calling GlobalApi->global_config_create: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://0.0.0.0:8001

Class Method HTTP request Description
GlobalApi global_config_create POST /global/config/
GlobalApi global_config_delete DELETE /global/config/{id}/
GlobalApi global_config_list GET /global/config/
GlobalApi global_config_partial_update PATCH /global/config/{id}/
GlobalApi global_config_read GET /global/config/{id}/
GlobalApi global_config_update PUT /global/config/{id}/
LightApi light_config_calendar_create POST /light/config-calendar/
LightApi light_config_calendar_delete DELETE /light/config-calendar/{id}/
LightApi light_config_calendar_list GET /light/config-calendar/
LightApi light_config_calendar_partial_update PATCH /light/config-calendar/{id}/
LightApi light_config_calendar_read GET /light/config-calendar/{id}/
LightApi light_config_calendar_update PUT /light/config-calendar/{id}/
LightApi light_config_create POST /light/config/
LightApi light_config_daily_create POST /light/config-daily/
LightApi light_config_daily_delete DELETE /light/config-daily/{id}/
LightApi light_config_daily_list GET /light/config-daily/
LightApi light_config_daily_partial_update PATCH /light/config-daily/{id}/
LightApi light_config_daily_read GET /light/config-daily/{id}/
LightApi light_config_daily_update PUT /light/config-daily/{id}/
LightApi light_config_delete DELETE /light/config/{id}/
LightApi light_config_list GET /light/config/
LightApi light_config_partial_update PATCH /light/config/{id}/
LightApi light_config_read GET /light/config/{id}/
LightApi light_config_type_create POST /light/config-type/
LightApi light_config_type_delete DELETE /light/config-type/{id}/
LightApi light_config_type_list GET /light/config-type/
LightApi light_config_type_partial_update PATCH /light/config-type/{id}/
LightApi light_config_type_read GET /light/config-type/{id}/
LightApi light_config_type_update PUT /light/config-type/{id}/
LightApi light_config_update PUT /light/config/{id}/
LightApi light_controller_force_create POST /light/controller-force/
LightApi light_controller_force_delete DELETE /light/controller-force/{id}/
LightApi light_controller_force_list GET /light/controller-force/
LightApi light_controller_force_partial_update PATCH /light/controller-force/{id}/
LightApi light_controller_force_read GET /light/controller-force/{id}/
LightApi light_controller_force_update PUT /light/controller-force/{id}/
LightApi light_controller_list GET /light/controller/
LightApi light_controller_read GET /light/controller/{id}/
LightApi light_device_create POST /light/device/
LightApi light_device_delete DELETE /light/device/{id}/
LightApi light_device_list GET /light/device/
LightApi light_device_partial_update PATCH /light/device/{id}/
LightApi light_device_read GET /light/device/{id}/
LightApi light_device_update PUT /light/device/{id}/
LightApi light_sensor_list GET /light/sensor/
LightApi light_sensor_read GET /light/sensor/{id}/
SprinklerApi sprinkler_config_create POST /sprinkler/config/
SprinklerApi sprinkler_config_delete DELETE /sprinkler/config/{id}/
SprinklerApi sprinkler_config_list GET /sprinkler/config/
SprinklerApi sprinkler_config_partial_update PATCH /sprinkler/config/{id}/
SprinklerApi sprinkler_config_read GET /sprinkler/config/{id}/
SprinklerApi sprinkler_config_update PUT /sprinkler/config/{id}/
SprinklerApi sprinkler_controller_force_create POST /sprinkler/controller-force/
SprinklerApi sprinkler_controller_force_delete DELETE /sprinkler/controller-force/{id}/
SprinklerApi sprinkler_controller_force_list GET /sprinkler/controller-force/
SprinklerApi sprinkler_controller_force_partial_update PATCH /sprinkler/controller-force/{id}/
SprinklerApi sprinkler_controller_force_read GET /sprinkler/controller-force/{id}/
SprinklerApi sprinkler_controller_force_update PUT /sprinkler/controller-force/{id}/
SprinklerApi sprinkler_controller_list GET /sprinkler/controller/
SprinklerApi sprinkler_controller_read GET /sprinkler/controller/{id}/
SprinklerApi sprinkler_device_create POST /sprinkler/device/
SprinklerApi sprinkler_device_delete DELETE /sprinkler/device/{id}/
SprinklerApi sprinkler_device_list GET /sprinkler/device/
SprinklerApi sprinkler_device_partial_update PATCH /sprinkler/device/{id}/
SprinklerApi sprinkler_device_read GET /sprinkler/device/{id}/
SprinklerApi sprinkler_device_update PUT /sprinkler/device/{id}/
SprinklerApi sprinkler_sensor_list GET /sprinkler/sensor/
SprinklerApi sprinkler_sensor_read GET /sprinkler/sensor/{id}/
WaterApi water_config_create POST /water/config/
WaterApi water_config_delete DELETE /water/config/{id}/
WaterApi water_config_list GET /water/config/
WaterApi water_config_partial_update PATCH /water/config/{id}/
WaterApi water_config_read GET /water/config/{id}/
WaterApi water_config_update PUT /water/config/{id}/
WaterApi water_controller_force_create POST /water/controller-force/
WaterApi water_controller_force_delete DELETE /water/controller-force/{id}/
WaterApi water_controller_force_list GET /water/controller-force/
WaterApi water_controller_force_partial_update PATCH /water/controller-force/{id}/
WaterApi water_controller_force_read GET /water/controller-force/{id}/
WaterApi water_controller_force_update PUT /water/controller-force/{id}/
WaterApi water_controller_list GET /water/controller/
WaterApi water_controller_read GET /water/controller/{id}/
WaterApi water_device_create POST /water/device/
WaterApi water_device_delete DELETE /water/device/{id}/
WaterApi water_device_list GET /water/device/
WaterApi water_device_partial_update PATCH /water/device/{id}/
WaterApi water_device_read GET /water/device/{id}/
WaterApi water_device_update PUT /water/device/{id}/
WaterApi water_sensor_list GET /water/sensor/
WaterApi water_sensor_read GET /water/sensor/{id}/

Documentation For Models

Documentation For Authorization

Basic

  • Type: HTTP basic authentication

Author

[email protected]

Notes for Large OpenAPI documents

If the OpenAPI document is large, imports in og_client.apis and og_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 og_client.api.default_api import DefaultApi
  • from og_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 og_client
from og_client.apis import *
from og_client.models import *

About

Official Python OpenApi client

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages