Skip to main content

A Colorful AWS SDK wrapper for Python

Project description

pinkboto

A Colorful AWS SDK wrapper for Python

Current version at PyPI Supported Python Versions Software status PyPI - Downloads

Install

pip install pinkboto

Usage

import pinkboto
aws = pinkboto.aws(profile='production', region='us-east-1') 
selector = {'resource': 'aws_db_instance'}
projection = ['DBInstanceIdentifier', 'Endpoint']
rds = aws.find(selector, projection)

Caching

By default, pinkboto caching all requests with 120 seconds lifespan.

To disable:

aws = pinkboto.aws(profile='production', region='us-east-1', cache=False)

To modify lifespan to 1 hour:

aws = pinkboto.aws(profile='production', region='us-east-1', cache=3600)

AWS Lambda usage

When using pinkboto in an AWS Lambda it is important to change the cache folder to the /tmp writable folder.

aws = pinkboto.aws(profile='production', region='us-east-1', cache=3600, cache_folder='/tmp/pinkboto')

Subfield projection

You can access a subfield in projection. For example 'Endpoint.Address' in rds

rds = aws.find({'resource': 'aws_db_instance'}, ['Endpoint.Address', 'AvailabilityZone'])

CSV output

pinkboto.to_csv(rds, 'result.csv')

pypi package publish

update setup.py version.
python3 setup.py sdist
twine upload dist/pinkboto-${new-version}.tar.gz

Contributing

Pull requests for new features, bug fixes, and suggestions are welcome!

License

GNU General Public License v3 (GPLv3)

Developer install requirements

pre-commit install

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

pinkboto-0.0.46.tar.gz (23.0 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