Skip to main content
Help the Python Software Foundation raise $60,000 USD by December 31st!  Building the PSF Q4 Fundraiser

Pollination Server

Project description

pollination-sdk

Pollination Server OpenAPI Defintion

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

  • API version: 0.10.10
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://pollination.cloud

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly 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 https://api.pollination.cloud
configuration.host = "https://api.pollination.cloud"
# 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)
username = ['username_example'] # list[str] | Username of the user to search for (optional)

try:
    # List Users
    api_response = api_instance.list_users(page=page, per_page=per_page, username=username)
    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 https://api.pollination.cloud

Class Method HTTP request Description
APITokensApi create_token POST /tokens Create a new API token
APITokensApi list_tokens GET /tokens List user API tokens
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 delete_operator_org_permission DELETE /operators/{owner}/{name}/permissions Remove a Repository permissions
OperatorsApi get_operator GET /operators/{owner}/{name} Get an operator
OperatorsApi get_operator_access_permissions GET /operators/{owner}/{name}/permissions Get operator access permissions
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
OperatorsApi upsert_operator_permission PATCH /operators/{owner}/{name}/permissions Upsert a new permission to a 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 organization 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 create_project_recipe_filter POST /projects/{owner}/{name}/recipes/filters Upsert a recipe filter to 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 delete_project_recipe_filter DELETE /projects/{owner}/{name}/recipes/filters 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 project access permissions
ProjectsApi get_project_recipe_filters GET /projects/{owner}/{name}/recipes/filters Get project recipe filters
ProjectsApi get_project_recipes GET /projects/{owner}/{name}/recipes Get project recipes
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 delete_recipe_org_permission DELETE /recipes/{owner}/{name}/permissions Remove a Repository permissions
RecipesApi get_recipe GET /recipes/{owner}/{name} Get a recipe
RecipesApi get_recipe_access_permissions GET /recipes/{owner}/{name}/permissions Get recipe access permissions
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
RecipesApi upsert_recipe_permission PATCH /recipes/{owner}/{name}/permissions Upsert a new permission to 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 download_simulation_artifact GET /projects/{owner}/{name}/simulations/{simulation_id}/artifacts/download Download an artifact from the simulation folder
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_task_logs GET /projects/{owner}/{name}/simulations/{simulation_id}/task/{task_id}/logs Get simulation logs
SimulationsApi list_simulation_artifacts GET /projects/{owner}/{name}/simulations/{simulation_id}/artifacts List artifacts in a simulation folder
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 team 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 Team Member
UserApi get_me GET /user Get authenticated user profile.
UserApi get_roles GET /user/roles Get the authenticated user roles
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

Documentation For Authorization

APIKeyAuth

  • Type: API key
  • API key parameter name: x-pollination-token
  • Location: HTTP header

JWTAuth

  • Type: Bearer authentication

Author

info@pollination.cloud

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pollination-sdk, version 0.10.10
Filename, size File type Python version Upload date Hashes
Filename, size pollination_sdk-0.10.10-py3-none-any.whl (254.6 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size pollination-sdk-0.10.10.tar.gz (122.3 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page