Skip to main content

saltant SDK for Python

Project description

Build Status codecov Documentation Status PyPI PyPI - Python Version Code style: black

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


Using pip,

pip install saltant-py

or, from source, after cloning this repository, run

python install

where python is in versions 2.7 or 3.5+.


After connecting to the saltant server with

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


from saltant.client import Client
client = Client(

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

You can launch task instances:

# Launch a task instance
my_task_instance = client.container_task_instances.create(,
    arguments={"launch_code": 12345},

# Wait for the task instance to finish

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

See also

saltant-cli, a saltant CLI.

Project details

Download files

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

Source Distribution

saltant-py-0.3.0.tar.gz (13.9 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page