A Python SDK for Spotinst
Project description
Spotinst SDK Python
The official Spotinst SDK for the Python programming language.
Version 2
Version 2 for the Spotinst Python SDK will be moving from the v2
branch to the master
branch very soon. The current master
will move to it's own v1
branch and eventually be deprecated. Version 2 introduces some breaking changes from v1 and will require updates when switching over. Luckily this process should be easy and is completely explained on the v2 branch in this repository. Both v1
and v2
will be released as spotinst-sdk
and spotinst-sdk2
respectively, to prevent any auto version upgrades.
Table of Contents
Installation
pip install --upgrade spotinst-sdk
Authentication
The mechanism in which the SDK looks for credentials is to search through a list of possible locations and stop as soon as it finds credentials. The order in which the SDK searches for credentials is:
- Passing credentials as parameters when creating a
SpotinstClient
object:
session = SpotinstClient(auth_token='foo', account_id='bar')
- Environment variables:
export SPOTINST_TOKEN=foo
export SPOTINST_ACCOUNT=bar
- Shared credentials file:
-
The shared credentials file has a default location of
~/.spotinst/credentials
. This file is an INI formatted file with section names corresponding to profiles. With each section, two configuration variables can be specified:token
,account
. These are the only supported values in the shared credential file. -
Below is a minimal example of the shared credentials file:
[default]
token = foo
account = bar
- The shared credentials file also supports the concept of profiles. Profiles represent logical groups of configuration. The shared credential file can have multiple profiles:
[default]
token = foo
account = bar
[dev]
token = foo2
account = bar2
[prod]
token = foo3
account = bar3
-
You can configure your Spot credentials using the
spotctl configure
command. For more information, see thespotctl
Getting Started. -
To maintain compatibility with previous SDK versions, the file can also be in YAML format:
default:
token: foo
account: bar
dev:
token: foo2
account: bar2
prod:
token: foo3
account: bar3
- You can change the location of the credentials file and the profile used by setting the
SPOTINST_SHARED_CREDENTIALS_FILE
and/orSPOTINST_PROFILE
environment variables:
export SPOTINST_SHARED_CREDENTIALS_FILE=/path/to/credentials_file
export SPOTINST_PROFILE=dev
- Passing the credentials file location and the profile used as parameters when creating a
SpotinstClient
object:
session = SpotinstClient(credentials_file='/path/to/credentials_file', profile='dev')
Documentation
For a comprehensive documentation, check out the API documentation.
Getting Help
We use GitHub issues for tracking bugs and feature requests. Please use these community resources for getting help:
- Ask a question on Stack Overflow and tag it with spotinst-sdk-python.
- Join our Spotinst community on Slack.
- Open an issue.
Community
License
Code is licensed under the Apache License 2.0. See NOTICE.md for complete details, including software and third-party licenses and permissions.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.