Aqualink API documentation
Project description
aqualink-api
The Aqualink public API documentation
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 1.0.0
- Package version: 1.0.8
- 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 aqualink-api
(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 aqualink_sdk
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 aqualink_sdk
Getting Started
Please follow the installation procedure and then run the following:
import time
import aqualink_sdk
from pprint import pprint
from aqualink_sdk.api import collections_api
from aqualink_sdk.model.collection import Collection
from aqualink_sdk.model.create_collection_dto import CreateCollectionDto
from aqualink_sdk.model.inline_response401 import InlineResponse401
from aqualink_sdk.model.inline_response404 import InlineResponse404
from aqualink_sdk.model.update_collection_dto import UpdateCollectionDto
# Defining the host is optional and defaults to https://ocean-systems.uc.r.appspot.com/api
# See configuration.py for a list of all supported configuration parameters.
configuration = aqualink_sdk.Configuration(
host = "https://ocean-systems.uc.r.appspot.com/api"
)
# 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 Bearer authorization (JWT): bearer
configuration = aqualink_sdk.Configuration(
access_token = 'YOUR_BEARER_TOKEN'
)
# Enter a context with an instance of the API client
with aqualink_sdk.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = collections_api.CollectionsApi(api_client)
create_collection_dto = CreateCollectionDto(
name="La Niña heatwave 20/21",
user_id=1,
site_ids=[1,3,5],
is_public=True,
) # CreateCollectionDto |
try:
# Creates a new collection
api_response = api_instance.collections_controller_create(create_collection_dto)
pprint(api_response)
except aqualink_sdk.ApiException as e:
print("Exception when calling CollectionsApi->collections_controller_create: %s\n" % e)
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
aqualink-api-1.0.8.tar.gz
(85.9 kB
view hashes)
Built Distribution
aqualink_api-1.0.8-py3-none-any.whl
(243.4 kB
view hashes)
Close
Hashes for aqualink_api-1.0.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 48d0c33a6b73cc7553a5faf772c4fce302ba49f4a8f6994fd9529a86f539dbd5 |
|
MD5 | 14d4c6296d0b7678e1c8047f2278babf |
|
BLAKE2b-256 | f853dd4185c45411ac35ce57a64624eba4ad91b8dce44b9e88c93ac9c6428670 |