Skip to main content
Join the official Python Developers Survey 2018 and win valuable prizes: Start the survey!

saltant SDK for Python

Project description

Build Status Documentation Status PyPI PyPI - Python Version

saltant SDK for Python

saltant-py is a Python SDK for saltant. It lets you perform any action possible on the saltant API (some much more conveniently) within the comforts (hopefully) of Python. As a refresher, you might want to look at saltant's API reference to see what actions are possible.

The documentation for saltant-py is fairly comprehensive, and can be found at saltant-py.readthedocs.io.

Installation

Using pip,

pip install saltant-py

or, from source, after cloning this repository, run

python setup.py install

where python is in versions 2.7 or 3.5+.

Usage

After connecting to the saltant server with

from saltant.client import from_env
client = from_env() # uses env vars

or

from saltant.client import Client
client = Client(
    base_api_url='https://shahlabjobs.ca/api/',
    auth_token='p0gch4mp101fy451do9uod1s1x9i4a')

You can perform API operations on task types:

# Load in a task type
my_task_type = client.container_task_types.get(id=1)

# Edit the description of the task type
my_task_type.description = "this description is better"

# Push the description upstream
my_task_type.put()

You can launch task instances:

# Launch a task instance
my_task_instance = client.container_task_instances.create(
    task_type_id=my_task_type.id,
    task_queue_id=1,
    arguments={"launch_code": 12345},
)

# Wait for the task instance to finish
my_task_instance.wait_until_finished()

And much more! (See the docs for more details.)

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
saltant-py-0.1.0.tar.gz (13.1 kB) Copy SHA256 hash SHA256 Source None Sep 24, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page