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
SpotinstClientobject:
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 configurecommand. For more information, see thespotctlGetting 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_FILEand/orSPOTINST_PROFILEenvironment 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
SpotinstClientobject:
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.
1 maintainer
Metadata
1 maintainer
Release files for spotinst-sdk 1.0.56
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| spotinst-sdk-1.0.56.tar.gz | 32.9 kB | Without provenance | Details |
Release files / spotinst-sdk-1.0.56.tar.gz
| Download URL | spotinst-sdk-1.0.56.tar.gz |
|---|---|
| Size | 32.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7158f1eb69974f25deb225b3848a5e33248d88cec872aef3d5f3c29003a0db0b
|
|
BLAKE2b-256 checksum How to use checksums |
554e79be02bcdd9a39f2fe6598c2a536a2a4f6b74a26e924cbd27ea62f957f7d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.5
|
Security for spotinst-sdk 1.0.56
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
