pollination.cloud
Project description
pollination-sdk
Pollination Cloud API
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 0.0.1
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
Requirements
Python 2.7 and 3.4+
Installation & Usage
pip install
The default way to install pollination-sdk
is through PyPi as follows:
pip install pollination-sdk
If you need a specific branch you can install straight from the repository 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 pollination_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 pollination_sdk
Getting Started
Please follow the installation procedure and then run the following:
from __future__ import print_function
import time
import pollination_sdk
from pollination_sdk.rest import ApiException
from pprint import pprint
configuration = pollination_sdk.Configuration()
# Retrieve a temporary Acces Token (JWT) using your API key id and secret
API_KEY_ID = 'some-long-id'
API_KEY_SECRET = 'some-long-secret'
auth = pollination_sdk.AuthenticationApi()
api_token = pollination_sdk.Token(
id=API_KEY_ID,
secret=API_KEY_SECRET
)
auth_response = auth.login(token)
# Configure Bearer authorization: JWT
configuration.access_token = auth_response.access_token
# Defining host is optional and default to https://api.pollination.cloud
configuration.host = "https://api.pollination.cloud"
# Create an instance of the API class
api_instance = pollination_sdk.WorkflowsApi(pollination_sdk.ApiClient(configuration))
id = 'id_example' # str |
workflow = pollination_sdk.Workflow() # Workflow |
try:
# Update a Workflow
api_response = api_instance.update(id, workflow)
pprint(api_response)
except ApiException as e:
print("Exception when calling WorkflowsApi->update: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to https://api.pollination.cloud
Class | Method | HTTP request | Description |
---|---|---|---|
AuthenticationApi | create_api_token | POST /auth/api-token | Create an API Token |
AuthenticationApi | delete_api_token | DELETE /auth/api-token | Delete an API Token |
AuthenticationApi | get_api_token | GET /auth/api-token | Get your API Token ID |
AuthenticationApi | login | POST /auth/login | Login with API Token |
AuthenticationApi | rotate_api_token_secret | PUT /auth/api-token | Rotate an API token secret |
ModelApi | create | POST /models | Create a Model |
ModelApi | create_faces | POST /models/{id}/faces | Create Model Faces |
ModelApi | delete | DELETE /models/{id} | Delete a Model |
ModelApi | get | GET /models/{id} | Get a Model |
ModelApi | get_faces | GET /models/{id}/faces | Get Model Faces |
ModelApi | list | GET /models | Get Models |
SensorGridApi | create | POST /sensor-grids | Create a Sensor Grid |
SensorGridApi | delete | DELETE /sensor-grids/{gid} | Delete a Sensor Grid |
SensorGridApi | get | GET /sensor-grids/{gid} | Get a Sensor Grid |
SensorGridApi | get_sensors | GET /sensor-grids/{gid}/sensors | Get Sensors |
SensorGridApi | list | GET /sensor-grids | Get Sensor Grids |
SimulationsApi | create | POST /simulations | Schedule a simulation |
SimulationsApi | get | GET /simulations/{id} | Get a Simulation |
SimulationsApi | get_simulation_inputs | GET /simulations/{id}/inputs | Get simulation inputs |
SimulationsApi | get_simulation_logs | GET /simulations/{id}/logs | Get simulation logs |
SimulationsApi | get_simulation_outputs | GET /simulations/{id}/outputs | Get simulation outputs |
SimulationsApi | get_task_logs | GET /simulations/{id}/task/{task_id}/logs | Get a simulation task's logs |
SimulationsApi | list | GET /simulations | List simulations |
SimulationsApi | resubmit | POST /simulations/{id}/re-submit | re-submit a simulation |
SimulationsApi | resume | PUT /simulations/{id}/resume | resume a simulation |
SimulationsApi | suspend | PUT /simulations/{id}/suspend | Suspend a simulation |
WorkflowsApi | create | POST /workflows | Create a Workflow |
WorkflowsApi | delete | DELETE /workflows/{id} | Delete a Workflow |
WorkflowsApi | get | GET /workflows/{id} | Get a Workflow |
WorkflowsApi | list | GET /workflows | List Workflows |
WorkflowsApi | update | PUT /workflows/{id} | Update a Workflow |
Documentation For Models
- Accepted
- Aperture
- App
- ArgoArchiveLocation
- ArgoArguments
- ArgoArtifact
- ArgoDAG
- ArgoDAGTask
- ArgoNodeStatus
- ArgoOutputs
- ArgoParameter
- ArgoRetryStrategy
- ArgoS3Location
- ArgoStatus
- ArgoSuspend
- ArgoTaskContainer
- ArgoTemplate
- ArgoTemplateRef
- Arguments
- Artifact
- Auth0TokenResponse
- CreatedContent
- DAG
- DAGTask
- Face
- Function
- Glass
- HTTPLocation
- HTTPValidationError
- InputFolderLocation
- KeySecret
- Language
- LocalRequirements
- LoopControl
- Model
- Model1
- ModelOut
- NewToken
- Opaque
- Operator
- Package
- Parameter
- Parent
- Plastic
- ReferenceWorkflow
- RunFolderLocation
- S3Location
- Sensor
- SensorGridIn
- SensorGridIn1
- SensorGridOut
- ShadeFace
- SubmitSimulation
- Token
- Transparent
- ValidationError
- Vertex
- Workflow
- WorkflowListItem
Documentation For Authorization
JWT
- Type: Bearer authentication
Author
Project details
Release history Release notifications | RSS feed
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 pollination_sdk-0.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a54be9969ec19aa16c88194a211474649776355839fe2ec6abee5bfd2ddeb041 |
|
MD5 | a672f766f78742fbd45172cbf042cbca |
|
BLAKE2b-256 | c9641c197b2c7cde13b1df727dc042b0b612557f54ed6c6fdc67b7fd971e294e |