pollination-sdk 0.6.2

Pollination Server

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: v0.2.2
• 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 token
API_TOKEN = 'some-token-string'

auth = pollination_sdk.UserApi()
api_token = pollination_sdk.LoginDto(
  api_token=API_TOKEN
)

auth_response = auth.login(api_token)

# Configure Bearer authorization: JWT
configuration.access_token = auth_response.access_token

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"
# Create an instance of the API class
api_instance = pollination_sdk.WorkflowsApi(pollination_sdk.ApiClient(configuration))
owner = 'owner_example' # str | 
name = 'name_example' # str | 
team_name = 'team_name_example' # str | 
permission = 'permission_example' # str | 

try:
    # Upsert a Workflow team level permission
    api_response = api_instance.upsert_workflow_team_permission(owner, name, team_name, permission)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WorkflowsApi->upsert_workflow_team_permission: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
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	list_artifacts	GET /projects/{owner}/{name}/artifacts	List artifacts in a project folder
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
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_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	resubmit_simulation	POST /projects/{owner}/{name}/simulations/{simulation_id}/re-submit	re-submit a simulation
SimulationsApi	resume_simulation	PUT /projects/{owner}/{name}/simulations/{simulation_id}/resume	resume 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
WorkflowsApi	create_workflow	POST /workflows/{owner}	Create a Workflow
WorkflowsApi	delete_workflow	DELETE /workflows/{owner}/{name}	Delete a Workflow
WorkflowsApi	delete_workflow_org_permission	DELETE /workflows/{owner}/{name}/permissions/org/{org_role}	Remove a Workflow org level permission
WorkflowsApi	delete_workflow_team_permission	DELETE /workflows/{owner}/{name}/permissions/team/{team_name}	Remove a Workflow team level permission
WorkflowsApi	get_workflow	GET /workflows/{owner}/{name}	Get a workflow
WorkflowsApi	get_workflow_access_permissions	GET /workflows/{owner}/{name}/permissions	Get a workflow's access permissions
WorkflowsApi	list_workflows	GET /workflows	List Workflows
WorkflowsApi	update_workflow	PUT /workflows/{owner}/{name}	Update a Workflow
WorkflowsApi	upsert_workflow_org_permission	PATCH /workflows/{owner}/{name}/permissions/org/{org_role}/{permission}	Upsert a Workflow org level permission
WorkflowsApi	upsert_workflow_team_permission	PATCH /workflows/{owner}/{name}/permissions/team/{team_name}/{permission}	Upsert a Workflow team level permission

Documentation For Models

• Accepted
• AccountPublic
• AppModulesProjectsDtoProjectAccessPolicyDto
• AppModulesProjectsDtoProjectPolicySubjectDto
• AppModulesProjectsInterfacePermissions
• AppModulesWorkflowsDtoAccessPolicyDto
• AppModulesWorkflowsDtoPolicySubjectDto
• AppModulesWorkflowsInterfacePermissions
• Arguments
• Artifact
• CreateOrgDto
• CreateTokenDto
• CreateWorkflowDto
• CreatedContent
• DAG
• DAGTask
• EmailRequest
• FileMeta
• Function
• HTTPLocation
• HTTPValidationError
• InputFolderLocation
• KeyRequest
• LoginDto
• LoginToken
• Operator
• OrgDto
• OrgMemberDto
• Parameter
• PatchOrgDto
• PatchProjectDto
• PatchTeamDto
• PatchWorkflow
• PrivateUserDto
• ProjectDto
• PublicUserDto
• RefreshTokenDto
• RunFolderLocation
• S3Location
• S3UploadRequest
• SignUpDto
• SimulationStatus
• SubmitSimulationDto
• TaskStatus
• TeamDto
• TeamMemberDto
• TeamOrg
• UpdateAccepted
• UserMetadata
• ValidationError
• Workflow
• WorkflowDto

Documentation For Authorization

JWT

• Type: Bearer authentication

Author