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
This is a small Messnger with the cmd as an interface

Messenger This is a small messenger with the cmd as an interface. It started as a project to learn more about Python 3. If you want to run a version o

1 Feb 24, 2022
Automation application was made by me using Google, Sheet and Slack APIs with Python.

README This application is used to transfer the data in the xlsx document we have to the Google Drive environment and calculate the "total budget" wit

3 Apr 12, 2022
A google search telegram bot.

Google-Search-Bot A google search telegram bot. Made with Python3 (C) @FayasNoushad Copyright permission under MIT License License - https://github.c

Fayas Noushad 37 Nov 24, 2022
A bot to playing music in telegram vcg

Idzeroid Music|| Idzeroid Music adalah sebuah repository music bot telegram untuk memainkan suara di voice chat group anda. Fyi This repo im using for

idzeroid 1 Oct 26, 2021
The Discord bot framework for Python

Pycordia ⚠️ Note! As of now, this package is under early development so functionalities are bound to change drastically. We don't recommend you curren

Ángel Carias 24 Jan 01, 2023
Just another Shiny and Greninja-ash killing preventor for Myuu

Myuu-Anti-Shiny-Discord-Bot Why I made it? Since, I was legit fed up of NebbyBot's lag (not criticising it), I decided to make my own but in python an

5 Nov 12, 2022
Nft-maker - Create your own NFT!

nft-maker How to If you're going to use this program, change the pictures in the "images" folder. All images must be of the same resolution and size.

Georgii Arakelian 4 Mar 13, 2022
Github Workflows üzerinde Çalışan A101 Aktüel Telegam Bot

A101AktuelRobot Github Workflows üzerinde Çalışan A101 Aktüel Telegam Bot @A101AktuelRobot 💸 Bağış Yap ☕️ Kahve Ismarla 🌐 Telif Hakkı ve Lisans Copy

Ömer Faruk Sancak 10 Nov 02, 2022
An Amazon Product Scraper built using scapy module of python

Amazon Product Scraper This is an Amazon Product Scraper built using scapy module of python Features it scrape various things Product Title Product Im

Sudhanshu Jha 1 Dec 13, 2021
Python library to connect to Firebots API

This is a firebot library to connect to Firebots API. https://firebot.app/ From Firebots Website: "Firebot is a fully featured open-source bot that c

1 Jan 08, 2022
A Next-Gen modular Python3 Telegram-Bot with Anime Theme to it.

Hsea Robot A modular Telegram Python bot running on python3 with a sqlalchemy database and an entirely themed persona to make Cutiepii suitable for An

Wahyusaputra 1 Dec 29, 2021
OpenSource bot for control groups ...

⭕️ کمک به افراد برای اداره هرچه فان تره گروه 📟 همه گروه های بزرگ نیاز به یه بات خفن دارن تا از گروه مراقبت کنه این بات کارش همینه سعی کرده فیچر خیلی

Mehran Alam Beigi 2 Nov 26, 2021
Quickly visualize docker networks with graphviz.

Docker Network Graph Visualize the relationship between Docker networks and containers as a neat graphviz graph. Example Usage usage: docker-net-graph

Leo Verto 43 Dec 12, 2022
Lumi-Bot - Discord bot that fetches cryptocurrency prices utilizing CoinGeko API

Lumi-Bot Discord bot that fetches and monitors cryptocurrency prices utilizing C

Diego Castro 2 Oct 08, 2022
A cross-platform script to book first available time for getting a passport in Sweden - Ett skript som automatiskt bokar pass hos polisen

Automatic passport booker - Boka pass automatiskt hos Svenska polisen A cross-platform script to book first available time for getting a passport in S

Elias Floreteng 14 Oct 17, 2022
Quadrirrotor UFABC - ROS/Gazebo

QuadROS_UFABC - Repositório utilizado durante minha dissertação de mestrado para simular sistemas de controle e estimação para navegação de um quadrirrotor utilizando visão computacional.

Mateus Ribeiro 1 Dec 13, 2022
🤖 Telegram UserBot Untuk Memutar Lagu Dan Video Di Obrolan Suara Telegram.

🤖 Telegram UserBot Untuk Memutar Lagu Dan Video Di Obrolan Suara Telegram.

Fariz 2 Nov 13, 2021
Demonstrate how GitHub OIDC token getting should be included in boto3

boto3 should add direct support for AssumeRoleWithWebIdentity for GitHub Actions There is a aws-actions/configure-aws-credentials action that will get

Ben Kehoe 11 Aug 29, 2022
CyberTKR - CyberTK-API

CyberTKR - CyberTK-API

TKR 2 Apr 08, 2022
A Pluggable And Powerful Telegram Manager Bot

FRIDAY-USERBOT 🇮🇳 A Powerful, Smart And Simple Userbot In Pyrogram. Support 🚑 Inspiration & Credits Userge-X Userge Pokurt Pyrogram Code Owners Chs

DevsExpo 371 Mar 26, 2022