Balsam Python client API & SDK

Overview

balsam

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.1.0
  • Package version: 0.0.1
  • 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 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 balsam

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 balsam

Getting Started

Please follow the installation procedure and then run the following:

create_apps_post: %s\n" % e) ">
import time
import balsam
from pprint import pprint
from balsam.api import apps_api
from balsam.model.app_create import AppCreate
from balsam.model.app_out import AppOut
from balsam.model.app_update import AppUpdate
from balsam.model.http_validation_error import HTTPValidationError
from balsam.model.paginated_apps_out import PaginatedAppsOut
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = balsam.Configuration(
    host = "http://localhost"
)

# 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 OAuth2 access token for authorization: OAuth2PasswordBearer
configuration = balsam.Configuration(
    host = "http://localhost"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Enter a context with an instance of the API client
with balsam.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = apps_api.AppsApi(api_client)
    app_create = AppCreate(
        site_id=3,
        name="NWChemGeomOpt",
        serialized_class="serialized_class_example",
        source_code="source_code_example",
        description="NWChem7 geometry optimizer",
        parameters={
            "key": AppParameter(
                required=True,
                default="default_example",
                help="",
            ),
        },
        transfers={
            "key": TransferSlot(
                required=True,
                direction=BalsamSchemasAppsTransferDirection("in"),
                local_path="local_path_example",
                description="",
                recursive=False,
            ),
        },
    ) # AppCreate | 

    try:
        # Create
        api_response = api_instance.create_apps_post(app_create)
        pprint(api_response)
    except balsam.ApiException as e:
        print("Exception when calling AppsApi->create_apps_post: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
AppsApi create_apps_post POST /apps/ Create
AppsApi delete_apps_app_id_delete DELETE /apps/{app_id} Delete
AppsApi list_apps_get GET /apps/ List
AppsApi read_apps_app_id_get GET /apps/{app_id} Read
AppsApi update_apps_app_id_put PUT /apps/{app_id} Update
AuthApi get_auth_methods_auth_how_get GET /auth/how Get Auth Methods
AuthApi login_auth_password_login_post POST /auth/password/login Login
AuthApi profile_auth_password_me_get GET /auth/password/me Profile
AuthApi register_auth_password_register_post POST /auth/password/register Register
BatchJobsApi bulk_update_batch_jobs_patch PATCH /batch-jobs/ Bulk Update
BatchJobsApi create_batch_jobs_post POST /batch-jobs/ Create
BatchJobsApi delete_batch_jobs_batch_job_id_delete DELETE /batch-jobs/{batch_job_id} Delete
BatchJobsApi list_batch_jobs_get GET /batch-jobs/ List
BatchJobsApi read_batch_jobs_batch_job_id_get GET /batch-jobs/{batch_job_id} Read
BatchJobsApi update_batch_jobs_batch_job_id_put PUT /batch-jobs/{batch_job_id} Update
EventsApi list_events_get GET /events/ List
JobsApi bulk_create_jobs_post POST /jobs/ Bulk Create
JobsApi bulk_update_jobs_patch PATCH /jobs/ Bulk Update
JobsApi delete_jobs_job_id_delete DELETE /jobs/{job_id} Delete
JobsApi list_jobs_get GET /jobs/ List
JobsApi query_delete_jobs_delete DELETE /jobs/ Query Delete
JobsApi query_update_jobs_put PUT /jobs/ Query Update
JobsApi read_jobs_job_id_get GET /jobs/{job_id} Read
JobsApi update_jobs_job_id_put PUT /jobs/{job_id} Update
SessionsApi acquire_sessions_session_id_post POST /sessions/{session_id} Acquire
SessionsApi create_sessions_post POST /sessions/ Create
SessionsApi delete_sessions_session_id_delete DELETE /sessions/{session_id} Delete
SessionsApi list_sessions_get GET /sessions/ List
SessionsApi tick_sessions_session_id_put PUT /sessions/{session_id} Tick
SitesApi create_sites_post POST /sites/ Create
SitesApi delete_sites_site_id_delete DELETE /sites/{site_id} Delete
SitesApi list_sites_get GET /sites/ List
SitesApi read_sites_site_id_get GET /sites/{site_id} Read
SitesApi update_sites_site_id_put PUT /sites/{site_id} Update
TransfersApi bulk_update_transfers_patch PATCH /transfers/ Bulk Update
TransfersApi list_transfers_get GET /transfers/ List
TransfersApi read_transfers_transfer_id_get GET /transfers/{transfer_id} Read
TransfersApi update_transfers_transfer_id_put PUT /transfers/{transfer_id} Update

Documentation For Models

Documentation For Authorization

OAuth2PasswordBearer

  • Type: OAuth
  • Flow: password
  • Authorization URL:
  • Scopes: N/A

Author

Notes for Large OpenAPI documents

If the OpenAPI document is large, imports in balsam.apis and balsam.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:

Solution 1: Use specific imports for apis and models like:

  • from balsam.api.default_api import DefaultApi
  • from balsam.model.pet import Pet

Solution 2: Before importing the package, adjust the maximum recursion limit as shown below:

import sys
sys.setrecursionlimit(1500)
import balsam
from balsam.apis import *
from balsam.models import *
You might also like...
Python SDK for accessing the Hanko Authentication API

Hanko Authentication SDK for Python This package is maintained by Hanko. Contents Introduction Documentation Installation Usage Prerequisites Create a

Python SDK for interacting with the Frame.io API.
Python SDK for interacting with the Frame.io API.

python-frameio-client Frame.io Frame.io is a cloud-based collaboration hub that allows video professionals to share files, comment on clips real-time,

DongTai API SDK For Python

DongTai-SDK-Python Quick start You need a config file config.json { "DongTai":{ "token":"your token", "url":"http://127.0.0.1:90"

Python 3 SDK/Wrapper for Huobi Crypto Exchange Api

This packages intents to be an idiomatic PythonApi wrapper for https://www.huobi.com/ Huobi Api Doc: https://huobiapi.github.io/docs Showcase TODO Con

wyscoutapi is an extremely basic API client for the Wyscout API (v2 & v3) for Python

wyscoutapi wyscoutapi is an extremely basic API client for the Wyscout API (v2 & v3). Usage Install with pip install wyscoutapi. To connect to the Wys

Beyonic API Python official client library simplified examples using Flask, Django and Fast API.
Beyonic API Python official client library simplified examples using Flask, Django and Fast API.

Beyonic API Python official client library simplified examples using Flask, Django and Fast API.

Python API Client for Twitter API v2
Python API Client for Twitter API v2

🐍 Python Client For Twitter API v2 🚀 Why Twitter Stream ? Twitter-Stream.py a python API client for Twitter API v2 now supports FilteredStream, Samp

Dns-Client-Server - Dns Client Server For Python

Dns-client-server DNS Server: supporting all types of queries and replies. Shoul

Raphtory-client - The python client for the Raphtory project

Raphtory Client This is the python client for the Raphtory project Install via p

Owner
Darren Govoni
Darren Govoni
Graviti-python-sdk - Graviti Data Platform Python SDK

Graviti Python SDK Graviti Python SDK is a python library to access Graviti Data

Graviti 13 Dec 15, 2022
Python SDK for Facebook's Graph API

Facebook Python SDK This client library is designed to support the Facebook Graph API and the official Facebook JavaScript SDK, which is the canonical

Mobolic 2.7k Jan 7, 2023
The Official Dropbox API V2 SDK for Python

The offical Dropbox SDK for Python. Documentation can be found on Read The Docs. Installation Create an app via the Developer Console. Install via pip

Dropbox 828 Jan 5, 2023
Unofficial Medium Python Flask API and SDK

PyMedium - Unofficial Medium API PyMedium is an unofficial Medium API written in python flask. It provides developers to access to user, post list and

Engine Bai 157 Nov 11, 2022
Python SDK for the Buycoins API.

This library provides easy access to the Buycoins API using the Python programming language. It provides all the feature of the API so that you don't need to interact with the API directly. This library can be used with Python 3.6+

Musa Rasheed 48 May 4, 2022
qualysclient - a python SDK for interacting with the Qualys API

qualysclient - a python SDK for interacting with the Qualys API

null 5 Oct 28, 2022
A Python 2.7/3.x module for Amcrest Cameras using the SDK HTTP API.

A Python 2.7/3.x module for Amcrest Cameras using the SDK HTTP API. Amcrest and Dahua devices share similar firmwares. Dahua Cameras and NVRs also work with this module.

Marcelo Moreira de Mello 176 Dec 21, 2022
An Python SDK for QQ based on mirai-api-http v2.

Argon 一个基于 graia-broadcast 和 mirai-api-http v2 的 Python SDK。 本项目适用于 mirai-api-http 2.0 以上版本。 目前仍处于开发阶段,内部接口可能会有较大的变化。 The Stasis / 停滞 为维持 GraiaProject

BlueGlassBlock 1 Oct 29, 2021
An elegant mirai-api-http v2 Python SDK.

Ariadne 一个适用于 mirai-api-http v2 的 Python SDK。 本项目适用于 mirai-api-http 2.0 以上版本。 目前仍处于开发阶段,内部接口可能会有较大的变化。 安装 poetry add graia-ariadne 或 pip install graia

Graia Project 259 Jan 2, 2023