https://github.com/fstab50/spotlib
Python 3 library for retrieval and processing of Amazon EC2 Spot Price history data
https://github.com/fstab50/spotlib
amazon-web-services aws ec2-spot ec2-spot-instances iam-permissions price-data python3 retrieve-data spotlib-library
Last synced: about 2 months ago
JSON representation
Python 3 library for retrieval and processing of Amazon EC2 Spot Price history data
- Host: GitHub
- URL: https://github.com/fstab50/spotlib
- Owner: fstab50
- License: gpl-3.0
- Created: 2019-07-27T19:48:24.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2022-07-23T21:03:43.000Z (almost 4 years ago)
- Last Synced: 2025-08-18T01:17:05.680Z (10 months ago)
- Topics: amazon-web-services, aws, ec2-spot, ec2-spot-instances, iam-permissions, price-data, python3, retrieve-data, spotlib-library
- Language: Python
- Homepage:
- Size: 3.38 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Summary
Python 3 library for retrieving historical spot prices from [Amazon EC2](http://aws.amazon.com/ec2) Service.
Internally, **spotlib** utilises a paged generator architecture to achieve maximum performance with non-blocking state transition.
Although **spotlib** was designed for maximum flexibility as a library, **spotlib** also includes a cli helper application, [spotcli](#spotcli), a cli binary which can be used directly for retrieving spot price data simple use cases.
**Version**: 0.2.10
* * *
## Contents
* [**Dependencies**](#dependencies)
* [**Installation**](#installation)
* [**Use**](#use)
* [**Spotlib Library**](#use)
* [**Spotcli Helper Application**](#spotcli-help)
* [Options](#spotcli-help)
* [Data Retrieval -- 1 AWS Region](#spotcli-1region)
* [Data Retrieval -- Multiple AWS Regions](#spotcli-multiregion)
* [**IAM Permissions**](#iam-permissions)
* [**Author & Copyright**](#author--copyright)
* [**License**](#license)
* [**Disclaimer**](#disclaimer)
--
[back to the top](#top)
* * *
## Dependencies
[spotlib](https://github.com/fstab50/spotlib) requires:
* [Python 3.6+](https://docs.python.org/3/).
* [Boto3](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/index.html) Python SDK for Amazon Web Services
* [Libtools](https://github.com/fstab50/libtools) General utilities library
[back to the top](#top)
* * *
## Installation
**spotlib** may be installed on Linux via [pip, python package installer](https://pypi.org/project/pip) in one of two methods:
To install **spotlib** for a single user:
```
$ pip3 install spotlib --user
```
To install **spotlib** for all users (Linux):
```
$ sudo -H pip3 install spotlib
```
[back to the top](#top)
* * *
## Use
* * *
### Use / Spotlib Library
**spotlib** can be used most flexibly as an importable library:
1. Initial Setup: Default endpoints for data retreival is a period of 1 day
```python
>>> from spotlib import SpotPrices, DurationEndpoints
>>> sp = SpotPrices()
```
```
# Display datetime endpoints
>>> sp.start
datetime.datetime(2019, 9, 17, 0, 0)
>>> sp.end
datetime.datetime(2019, 9, 18, 0, 0)
```
2. Set custom endpoints (start & end date times, 10 days back from today):
```python
>>> start, end = sp.set_endpoints(duration=10)
```
3. Retrieve spot price data for the custom time period for a particular region:
```python
>>> prices = sp.generate_pricedata(regions=['eu-west-1'])
```
4. Examine price data returned:
```python
>>> from libtools.js import export_iterobject
>>> export_iterobject(prices)
```
--
[back to the top](#top)
* * *
### Use / Spotcli Helper Application / Options
To display the help menu for **spotcli**, the included command line helper application:
```bash
$ spotcli --help
```
--
[back to the top](#top)
* * *
### Use / Spotcli Helper Application / Data Retrieval (1 region)
To run a test of the spotlib library, retrieve spot price data and writeout to disk:
```bash
$ spotcli --duration-days 3 --region eu-west-1
```
--
[back to the top](#top)
* * *
### Use / Spotcli Helper Application / Data Retrieval (multi-region)
To run a test of the spotlib library, retrieve spot price data and writeout to disk:
```bash
$ spotcli --duration-days 1 --region eu-west-1 eu-west-2 us-east-1
```
--
[back to the top](#top)
* * *
## IAM Permissions
Either an Identity and Access Management user or role must be used to retrieve spot price data from AWS. The following is the minimum permissions required to retrieve data:
```json
{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "VisualEditor0",
"Effect": "Allow",
"Action": [
"ec2:DescribeSpotPriceHistory",
"ec2:DescribeRegions"
],
"Resource": "*"
}
]
}
```
Alternatively, if more permissive (but still read-only) permissions can be tolerated, the AWS Managed Policy 'AmazonEC2ReadOnlyAccess' can be used via the following ARN:
* arn:aws:iam::aws:policy/AmazonEC2ReadOnlyAccess
The permissions above for IAM are a subset of the AmazonEC2ReadOnlyAccess policy. Either should work without problems.
--
[back to the top](#top)
* * *
## Author & Copyright
All works contained herein copyrighted via below author unless work is explicitly noted by an alternate author.
* Copyright Blake Huber, All Rights Reserved.
[back to the top](#top)
* * *
## License
* Software contained in this repo is licensed under the [license agreement](./LICENSE.md). You may display the license and copyright information by issuing the following command:
```
$ spotcli --version
```
[back to the top](#top)
* * *
## Disclaimer
*Code is provided "as is". No liability is assumed by either the code's originating author nor this repo's owner for their use at AWS or any other facility. Furthermore, running function code at AWS may incur monetary charges; in some cases, charges may be substantial. Charges are the sole responsibility of the account holder executing code obtained from this library.*
Additional terms may be found in the complete [license agreement](./LICENSE.md).
[back to the top](#top)
* * *
