Pollination Server
Project description
pollination-sdk
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: 0.7.5
- 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
# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"
# Create an instance of the API class
api_instance = pollination_sdk.UsersApi(pollination_sdk.ApiClient(configuration))
page = 1 # int | Page number starting from 1 (optional) (default to 1)
per_page = 25 # int | Number of items per page (optional) (default to 25)
name = 'name_example' # str | Name of the user to search for (optional)
username = 'username_example' # str | Username of the user to search for (optional)
id = [] # list[str] | A list of users to search for by their user ID (optional) (default to [])
try:
# List Users
api_response = api_instance.list_users(page=page, per_page=per_page, name=name, username=username, id=id)
pprint(api_response)
except ApiException as e:
print("Exception when calling UsersApi->list_users: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to http://localhost
Class | Method | HTTP request | Description |
---|---|---|---|
AccountsApi | get_account | GET /accounts/{name} | Get an account by name |
AccountsApi | list_accounts | GET /accounts | List Accounts on the Pollination platform |
ArtifactsApi | create_artifact | POST /projects/{owner}/{name}/artifacts | Get an Artifact upload link. |
ArtifactsApi | delete_artifact | DELETE /projects/{owner}/{name}/artifacts | Delete one or many artifacts by key/prefix |
ArtifactsApi | download_artifact | GET /projects/{owner}/{name}/artifacts/download | Download an artifact from the project folder |
ArtifactsApi | list_artifacts | GET /projects/{owner}/{name}/artifacts | List artifacts in a project folder |
OperatorsApi | create_operator | POST /operators/{owner} | Create an Operator |
OperatorsApi | create_operator_package | POST /operators/{owner}/{name}/tags | Create a new Operator package |
OperatorsApi | delete_operator | DELETE /operators/{owner}/{name} | Delete an Operator |
OperatorsApi | get_operator | GET /operators/{owner}/{name} | Get an operator |
OperatorsApi | get_operator_by_tag | GET /operators/{owner}/{name}/tags/{tag} | Get an operator tag |
OperatorsApi | list_operator_tags | GET /operators/{owner}/{name}/tags | Get an operator tags |
OperatorsApi | list_operators | GET /operators | List operators |
OperatorsApi | update_operator | PUT /operators/{owner}/{name} | Update an Operator |
OrgsApi | create_org | POST /orgs | Create an Org |
OrgsApi | delete_org | DELETE /orgs/{name} | Delete an Org |
OrgsApi | delete_org_member | DELETE /orgs/{name}/members/{username} | Remove an Org member |
OrgsApi | get_org | GET /orgs/{name} | Get an Org |
OrgsApi | get_org_members | GET /orgs/{name}/members | List an Org's members |
OrgsApi | list_orgs | GET /orgs | List Orgs |
OrgsApi | update_org | PUT /orgs/{name} | Update an Org |
OrgsApi | upsert_org_member | PATCH /orgs/{name}/members/{username}/{role} | Add or update the role of an Org Member |
ProjectsApi | create_project | POST /projects/{owner} | Create a Project |
ProjectsApi | delete_project | DELETE /projects/{owner}/{name} | Delete a Project |
ProjectsApi | delete_project_org_permission | DELETE /projects/{owner}/{name}/permissions | Remove a Project permissions |
ProjectsApi | get_project | GET /projects/{owner}/{name} | Get a project |
ProjectsApi | get_project_access_permissions | GET /projects/{owner}/{name}/permissions | Get a project's access permissions |
ProjectsApi | list_projects | GET /projects | List Projects |
ProjectsApi | update | PUT /projects/{owner}/{name} | Update a Project |
ProjectsApi | upsert_project_permission | PATCH /projects/{owner}/{name}/permissions | Upsert a new permission to a project |
RecipesApi | create_recipe | POST /recipes/{owner} | Create a Recipe |
RecipesApi | create_recipe_package | POST /recipes/{owner}/{name}/tags | Create a new Recipe package |
RecipesApi | delete_recipe | DELETE /recipes/{owner}/{name} | Delete a Recipe |
RecipesApi | get_recipe | GET /recipes/{owner}/{name} | Get a recipe |
RecipesApi | get_recipe_by_tag | GET /recipes/{owner}/{name}/tags/{tag} | Get a recipe tag |
RecipesApi | list_recipe_tags | GET /recipes/{owner}/{name}/tags | Get a recipe tags |
RecipesApi | list_recipes | GET /recipes | List recipes |
RecipesApi | update_recipe | PUT /recipes/{owner}/{name} | Update a Recipe |
RegistriesApi | get_package | GET /registries/{owner}/{type}/{name}/{digest} | Get Package |
RegistriesApi | get_registry_index | GET /registries/{owner}/index.json | Get Registry Index |
RegistriesApi | post_operator | POST /registries/{owner}/operators | Push an Operator to the registry |
RegistriesApi | post_recipe | POST /registries/{owner}/recipes | Push an Recipe to the registry |
SimulationsApi | create_simulation | POST /projects/{owner}/{name}/simulations | Schedule a simulation |
SimulationsApi | get_simulation | GET /projects/{owner}/{name}/simulations/{simulation_id} | Get a Simulation |
SimulationsApi | get_simulation_inputs | GET /projects/{owner}/{name}/simulations/{simulation_id}/inputs | Get simulation inputs |
SimulationsApi | get_simulation_logs | GET /projects/{owner}/{name}/simulations/{simulation_id}/logs | Get simulation logs |
SimulationsApi | get_simulation_output_artifact | GET /projects/{owner}/{name}/simulations/{simulation_id}/outputs/artifacts/{artifact_name} | Get simulation output artifact by name |
SimulationsApi | get_simulation_outputs | GET /projects/{owner}/{name}/simulations/{simulation_id}/outputs | Get simulation outputs |
SimulationsApi | get_simulation_task_logs | GET /projects/{owner}/{name}/simulations/{simulation_id}/task/{task_id}/logs | Get a simulation task's logs |
SimulationsApi | list_simulations | GET /projects/{owner}/{name}/simulations | List simulations |
SimulationsApi | resume_simulation | PUT /projects/{owner}/{name}/simulations/{simulation_id}/resume | resume a simulation |
SimulationsApi | stop_simulation | PUT /projects/{owner}/{name}/simulations/{simulation_id}/stop | Stop a simulation |
SimulationsApi | suspend_simulation | PUT /projects/{owner}/{name}/simulations/{simulation_id}/suspend | Suspend a simulation |
TeamsApi | create_team | POST /orgs/{org_name}/teams | Create a Team |
TeamsApi | delete_org_team_member | DELETE /orgs/{org_name}/teams/{team_slug}/members/{username} | Remove a team member |
TeamsApi | delete_team | DELETE /orgs/{org_name}/teams/{team_slug} | Delete a Team |
TeamsApi | get_org_team_members | GET /orgs/{org_name}/teams/{team_slug}/members | List a team's members |
TeamsApi | get_team | GET /orgs/{org_name}/teams/{team_slug} | Get a Team |
TeamsApi | list_org_teams | GET /orgs/{org_name}/teams | List Teams |
TeamsApi | update_team | PUT /orgs/{org_name}/teams/{team_slug} | Update a Team |
TeamsApi | upsert_org_team_member | PATCH /orgs/{org_name}/teams/{team_slug}/members/{username}/{role} | Add or update the role of an Org Member |
UserApi | change_password | POST /user/change_password | Make a password change request |
UserApi | get_me | GET /user | Get authenticated user profile. |
UserApi | get_roles | GET /user/roles | Get the authenticated user roles |
UserApi | list_refresh_tokens | GET /user/tokens | Get a list of token names |
UserApi | login | POST /user/login | Login to the platform and get a JWT back |
UserApi | signup | POST /user/signup | Sign Up to the platform! |
UserApi | upsert_refresh_token | POST /user/tokens | Get refresh token and delete previous one if it exists |
UsersApi | check_username | GET /users/check_username/{username} | Check if a username is already taken |
UsersApi | get_one_user | GET /users/{name} | Get a specific user profile |
UsersApi | list_users | GET /users | List Users |
Documentation For Models
- Accepted
- AccountPublic
- ArgumentArtifact
- ArgumentParameter
- Arguments
- BodyPostOperatorRegistriesOwnerOperatorsPost
- BodyPostRecipeRegistriesOwnerRecipesPost
- Config
- CreateOrgDto
- CreateTokenDto
- CreatedContent
- DAG
- DAGInputArtifact
- DAGInputParameter
- DAGInputs
- DAGOutputArtifact
- DAGOutputParameter
- DAGOutputs
- DAGTask
- DAGTaskArgument
- DAGTaskArtifactArgument
- DAGTaskLoop
- DAGTaskOutputArtifact
- DAGTaskOutputParameter
- DAGTaskOutputs
- DAGTaskParameterArgument
- Dependency
- DependencyType
- DockerConfig
- EmailRequest
- FileMeta
- FolderArtifactReference
- FolderReference
- Function
- FunctionArtifact
- FunctionInputs
- FunctionOutputs
- FunctionParameterIn
- FunctionParameterOut
- HTTPSource
- HTTPValidationError
- InputArtifactReference
- InputParameterReference
- InputReference
- ItemParameterReference
- ItemReference
- KeyRequest
- License
- LoginDto
- LoginToken
- LoopControl
- NewOperatorPackage
- NewRecipePackage
- NewRepositoryDto
- Operator
- OperatorPackage
- OperatorVersion
- OrgDto
- OrgMemberDto
- OrgRoleEnum
- PackageAbridgedDto
- PackageDto
- PackageListDto
- PatchOrgDto
- PatchProjectDto
- PatchTeamDto
- PrivateUserDto
- ProjectAccessPolicyDto
- ProjectDto
- ProjectFolderSource
- ProjectPermissions
- ProjectPolicyPermissionEnum
- ProjectPolicySubjectDto
- PublicAccountList
- PublicUserDto
- QueenbeeOperatorMetadataMaintainer
- QueenbeeOperatorMetadataMetaData
- QueenbeeRecipeMetadataMaintainer
- QueenbeeRecipeMetadataMetaData
- Recipe
- RecipePackage
- RecipeSelection
- RecipeVersion
- RefreshTokenDto
- RepositoryAbridgedDto
- RepositoryDto
- RepositoryIndex
- RepositoryListDto
- RepositoryPermissions
- S3Source
- S3UploadRequest
- SignUpDto
- SimulationList
- SimulationStatus
- StatusType
- SubmitSimulationDto
- TaskArtifactReference
- TaskParameterReference
- TaskReference
- TaskStatus
- TeamDto
- TeamMemberDto
- TeamOrg
- TeamRoleEnum
- UpdateAccepted
- UpdateRepositoryDto
- UserMetadata
- ValidationError
- WorkflowStatus
Documentation For Authorization
Compulsory Auth
- Type: Bearer authentication
JWT
- Type: Bearer authentication
Optional Auth
- 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.6.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f4d487b46797ec831f9d3cd41d5296977ec897e98cfc3dd65e823359f42c8a5f |
|
MD5 | 3212900d65af2ef4a189fcf3e6850e1a |
|
BLAKE2b-256 | 4b115764fd9d59fd0b305c0d097ad194d7061d263d16f936b8ed5cedcb0eb9a0 |