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
A Python wrapper for the QQ Channel API

A Python wrapper for the QQ Channel API

Fox_white 55 Dec 07, 2022
A Telegram Bot to manage your music channel with some cool features.

Music Channel Manager V2 A Telegram Bot to manage your music channel with some cool features like appending your predefined username to the musics tag

11 Oct 21, 2022
An inline real-time media searching robot without any database.

MediaBuddy A Telegram Inline media searching robot without any database. About mediaBuddy is an inline media searching robot. If you have so many movi

Renjith Mangal 28 Oct 21, 2022
Represents a Lavalink client used to manage nodes and connections.

lavaplayer Represents a Lavalink client used to manage nodes and connections. setup pip install lavaplayer setup lavalink you need to java 11* LTS or

HazemMeqdad 37 Nov 21, 2022
OpenQuake's Engine for Seismic Hazard and Risk Analysis

OpenQuake Engine The OpenQuake Engine is an open source application that allows users to compute seismic hazard and seismic risk of earthquakes on a g

Global Earthquake Model 281 Dec 21, 2022
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

丂ㄚ么乙ツ 2 Nov 17, 2021
Ethereum Gas Fee for the MacBook Pro touchbar (using BetterTouchTool)

Gasbar Ethereum Gas Fee for the MacBook Pro touchbar (using BetterTouchTool) Worried about Ethereum gas fees? Me too. I'd like to keep an eye on them

TSS 51 Nov 14, 2022
An Open-Source Discord bot created to provide basic functionality which should be in every discord guild. We use this same bot with additional configurations for our guilds.

A Discord bot completely written to be taken from the source and built according to your own custom needs. This bot supports some core features and is

Tesseract Coding 14 Jan 11, 2022
A multi-password‌ cracking tool that can help you hack facebook accounts very quickly

FbCracker This is a multi-password‌ cracking tool that can help you hack facebook accounts very quickly. Facebook Hacking Tool Installation On Termux

ReD H4CkeR 9 Nov 16, 2022
A Telegram Bin Checker Bot made with python for check Bin valid or Invalid. 💳

Bin Checker Bot A Telegram Bin Checker Bot made with python for check Bin valid or Invalid. 📌 Deploy On Heroku 🏷 Environment Variables API_ID - Your

Chamindu Denuwan 20 Dec 10, 2022
a Music bot for discord

Bot this is a discord bot made by AnHalfGuy.py#6031(ID: 747864072879603743) and HastagStopAnimalAbuse#5617(ID :349916852308279306) This Bot Is For Mus

A Discord Bot Development 1 Oct 29, 2021
A simple Facebook Account generator, written in python (needs different Email so Accounts do not get banned)

FacebookAccountGenerator FAB is a Facebook-Account generating script, written in python Installation Use the package manager pip to install selenium p

MrOverload 7 Jan 05, 2023
The system to host your files on the Discord application

Distorage The system to host your files on the Discord application Documentation Documentation Distorage How to use the package You can install it wit

6 Jun 27, 2022
🚀🔥使用Python连接阿里云盘, 实现了官方大部分功能 👍👍

aligo 🚀 🔥 使用Python连接阿里云盘, 实现了官方大部分功能 👍 👍 为了完善代码提示, 方便大家代码书写, aligo 引入了一些 python 3.8 的新特性, 所以要求 python = 3.8.* pip install aligo 或 pip install ali

455 Jan 08, 2023
A plugin for modmail-bot for stealing,making ,etc emojis

EmojiPlugin for the Modmail-bot My first plugin .. its very Basic I will make more and better too Only 3 commands for now emojiadd-supports .jpg, .png

1 Dec 28, 2021
Reverse engineered connection to the TradingView ticker in Python

Tradingview-ticker Reverse engineered connection to the TradingView ticker in Python. Makes a websocket connection to the Tradeview website and receiv

Aaron 20 Dec 02, 2022
Most Powerful Chatbot On Telegram Bot

About Hello, I am Lycia [リュキア], An Intelligent ChatBot. If You Are Feeling Lonely, You can Always Come to me and Chat With Me! How To Host The easiest

RedAura 8 May 26, 2021
A repository for 8G server's discord bot

8G Discord-Bot A general-purpose discord bot for the 8G Discord-Server To setup: Create a new file called secrets.py and make it look like this TOKEN=

1 Jan 12, 2022
An alternative to OpenFaaS nats-queue-worker for long-running functions

OpenFaas Job Worker OpenFaas Job Worker is a fork of project : OSCAR Worker - https://github.com/grycap/oscar-worker Thanks to Sebástian Risco @srisco

Sebastien Aucouturier 1 Jan 07, 2022
A high level library for building Discord bots.

Qord A high level library for building Discord bots. 🚧 This library is currently in development. Questions that you are having What is this? This is

Izhar Ahmad 16 May 14, 2022