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 *
Owner
Darren Govoni
Darren Govoni
GitPython is a python library used to interact with Git repositories.

Gitoxide: A peek into the future… I started working on GitPython in 2009, back in the days when Python was 'my thing' and I had great plans with it. O

3.8k Jan 03, 2023
Asynchronous Python Wrapper for the GoFile API

Asynchronous Python Wrapper for the GoFile API

Gautam Kumar 22 Aug 04, 2022
ImaginaryTicketing is a simple ticketing system for running CTF Competitions on discord.

ImaginaryTicketing ImaginaryTicketing is a simple ticketing system for running CTF Competitions on discord. Be sure to checkout ImaginaryCTF. See docs

GudOreos 8 Jul 18, 2022
Telegram Bot to save Posts or Files that can be Accessed via Special Links

OKAERI-FILE Bot Telegram untuk menyimpan Posting atau File yang dapat Diakses melalui Link Khusus. Jika Anda memerlukan tambahan module lagi dalam rep

Wahyusaputra 5 Aug 04, 2022
discord.js nuker (50 bans a sec)

js-nuker discord.js nuker (50 bans a sec) I was to lazy to make the scraper in js, but this works too. DISCLAIMER This is tool was made for educationa

4 Sep 11, 2021
Want to play What Would Rather on your Server? Invite the bot now! 😏

What is this Bot? 👀 What You Would Rather? is a Guessing game where you guess one thing. Long Description short Take this example: You typed r!rather

FSP Gang s' YT 3 Oct 18, 2021
An Advanced Telegram Bot to Play Radio & Music in Voice Chat. This is Also The Source Code of The Bot Which is Being Used For Playing Radio in @AsmSafone Channel ❤️

Telegram Radio Player V3 An Advanced Telegram Bot to Play Nonstop Radio/Music/YouTube Live in Channel or Group Voice Chats. This is also the source co

SAF ONE 421 Jan 05, 2023
An API wrapper for convertio.co written in Python.

An API wrapper for convertio.co written in Python.

Moonrise 9 Sep 27, 2022
A really easy way to display your spotify listening status on spotify.

Spotify playing README A really easy way to display your spotify listening status on READMEs and Websites too! Demo Here's the embed from the site. Cu

Sunrit Jana 21 Nov 06, 2022
Sentiment Analysis web app using Streamlit - American Airlines Tweets

Analyse des sentiments à partir des Tweets L'application est développée par Streamlit L'analyse sentimentale est effectuée sur l'ensemble de données d

Abida Hassan 2 Feb 04, 2022
修改自SharpNoPSExec的基于python的横移工具 A Lateral Movement Tool Learned From SharpNoPSExec -- Twitter: @juliourena

PyNoPSExec A Lateral Movement Tool Learned From SharpNoPSExec -- Twitter: @juliourena 根据@juliourena大神的SharpNOPsExec项目改写的横向移动工具 Platform(平台): Windows 1

<a href=[email protected]"> 23 Nov 09, 2022
Console BeautifulDiscord theme manager

BeautifulDiscord theme manager Console script for downloading & managing Discord .css themes via BeautifulDiscord. Setup Simply run # Linux/MacOS pip3

1 Dec 15, 2022
AWS Quick Start Team

EKS CDK Quick Start (in Python) DEVELOPER PREVIEW NOTE: Thise project is currently available as a preview and should not be considered for production

AWS Quick Start 83 Sep 18, 2022
Extend the commitizen tools to create conventional commits and README that link to Jira and GitHub.

cz-github-jira-conventional cz-github-jira-conventional is a plugin for the commitizen tools, a toolset that helps you to create conventional commit m

12 Dec 13, 2022
:lock: Python 2.7/3.X client for HashiCorp Vault

hvac HashiCorp Vault API client for Python 3.x Tested against the latest release, HEAD ref, and 3 previous minor versions (counting back from the late

hvac 1k Dec 29, 2022
PyDottie is a version of Dottie.js written in Python 3.

PyDottie is a version of Dottie.js written in Python 3.

Jose Noriega 2 Nov 21, 2021
Pure Python implementation of the Windows API method IDvdInfo2::GetDiscID.

pydvdid-m Pure Python implementation of the Windows API method IDvdInfo2::GetDiscID. This is a modification of sjwood's pydvdid. The Windows API metho

4 Nov 22, 2022
A wrapper for The Movie Database API v3 and v4 that only uses the read access token (not api key).

fulltmdb A wrapper for The Movie Database API v3 and v4 that only uses the read access token (not api key). Installation Use the package manager pip t

Jacob Hale 2 Sep 26, 2021
AminoAutoRegFxck/AutoReg For AminoApps.com

AminoAutoRegFxck AminoAutoRegFxck/AutoReg For AminoApps.com Termux apt update -y apt upgrade -y pkg install python git clone https://github.com/deluvs

3 Jan 18, 2022