Skip to main content

Cache AWS resources

Project description

Kinghorn

Python 3 library for caching AWS resources

Purpose

This library provides caching of AWS resources, which can save development time and money making API calls, as well as reduce the chances of errors taking place from running scripts against resources in flux. I use it to cache resources such as EC2 instances, volumes, and snapshots for retrieval in later scripts. I disliked having to call an API and perform an O(n^2) operation to unwrap my instance metadata every time I did something with boto3. With Kinghorn I can easily place resources in dictionaries for constant time access.

Opinions

I've chosen to discard metadata and "unwrap" entity metadata for storage. I've used clients instead of resources for Kinghorn to make it easy to alter the library to access low level API functions if needed. The library expects appropriate credentials in ~/.aws/credentials.

Installation instructions for Mac OS X

Publishing

  • Bump version in setup.py and kinghorn/__init.py__ and run ./publish.sh

Configuration

Configuration is handled with environment variables, as follows:

  • KINGHORN_ENVIRONMENT - Which environment your API credentials are for, for example factory, production, etc.
  • KINGHORN_LOGGING_OUT - Set to 1 to log to std out, useful for local testing and debugging
  • KINGHORN_LOGGING_LEVEL
  • KINGHORN_LOGGING_FILE
  • KINGHORN_CACHE_LOCATION

Files

  • publish.sh - Helper script to publish to PyPI
  • setup.py - Metadata for publishing packages
  • .gitignore - Files to ignore for git
  • kinghorn/__main__.py - Basic validation script for module
  • kinghorn/__init__.py - Exports all public functions
  • kinghorn/kinghorn.py - The library
  • kinghorn/test_kinghorn.py - An example file describing some ways to use the library and testing all functions

Future feature ideas

  • Additional entities for different services in AWS as I need them
  • Automated configurable cache expiration
  • Passthrough to the AWS API on cache miss

Project details


Download files

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

Files for kinghorn, version 0.0.7
Filename, size File type Python version Upload date Hashes
Filename, size kinghorn-0.0.7-py3-none-any.whl (6.2 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size kinghorn-0.0.7.tar.gz (4.7 kB) File type Source Python version None Upload date Hashes View hashes

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 DigiCert DigiCert EV certificate StatusPage StatusPage Status page