steampipe-alchemy 0.1.6

Python Boilerplate contains all the boilerplate you need to create a Python package.

steampipe-alchemy

A simple SQLAlchemy wrapper around Steampipe.

Currently this is a work in progress. Models exist for the AWS plugin, others will be added in the future.

• Free software: BSD license

• Documentation: [WIP] https://steampipe-alchemy.readthedocs.io.

Features

Install, setup, and start steampipe with the aws plugin.

# We're assuming the the AWS credentials are set in the environment here.
from steampipe_alchemy as sa

sa.install(['aws'])  # Downloads and installs steampipe with the aws plugin.
sa.update_config(aws={ #  Modifies ~/.local/share/steampipe_alchemy/config/aws.spc
    "plugin": "aws",
    "regions": ['us-east-1', 'us-west-1', 'us-west-2']
})
sa.start()  # Steampipe will be stopped when the script exits or when stop() is called.

We can then use the SQLAlchemy models to query AWS.

from steampipe_alchemy import query
from steampipe_alchemy.models import AwsS3Bucket

for b in query(AwsS3Bucket).limit(3):
    print(b.name)
    print("  Region: " + b.region)
    print("  Owner: " + str(b.acl['Owner']['DisplayName']))

Which will produce something like:

example-bucket-1234
  Region: us-east-1
  Owner: example-prod-account
example-bucket-2345
  Region: us-west-1
  Owner: example-prod-account
example-bucket-3456
  Region: us-west-2
  Owner: example-prod-account

The function steampipe_alchemy.query is a small wrapper around sqlalchemy.orm.Query. It is setup to use the steampipe sqlalchemy session and has type annotations which enable IDE completion on both the Model results and the Query class.

Models are located in steampipe_alchemy.models and are automatically generated with ./scripts/generate_models.py.

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

History

0.1.0 (2021-04-15)

• First release on PyPI.