Skip to main content

Various utilities that wrap around boto3 for CloudFormation service.

Project description

B.AwsCf

A python based package that enables convenient interaction with CloudFormation service boto3 library.

Description

Interacting with AWS CloudFormation service via boto3 is great. However, boto3 is far too low-level library giving you great flexibility but too less productivity. This B.AwsCf library makes interaction with CloudFormation more object-oriented and more high-level. It eliminates things like pagination with "NextToken" and so on.

Remarks

Biomapas aims to modernise life-science industry by sharing its IT knowledge with other companies and the community. This is an open source library intended to be used by anyone. Improvements and pull requests are welcome.

Related technology

  • Python 3
  • AWS CloudFormation
  • boto3

Assumptions

The project assumes the following:

  • You have basic-good knowledge in python programming.
  • You have basic-good knowledge in AWS.
  • You have basic-good knowledge in AWS CloudFormation.

Useful sources

Install

The project is built and uploaded to PyPi. Install it by using pip.

pip install b_aws_cf

Or directly install it through source.

pip install .

Usage & Examples

Programmatic usage

Two main constructs of this library is Stack and Stacks. The Stack class lets you work with a single stack and Stacks class lets you work with lists of stacks.

Stack class example.

from b_aws_cf.stack import Stack

# Create stack object just by knowing its name:
stack = Stack.from_name('MyCoolStack')

# Gets this stack's outptus:
outputs = stack.get_outputs()

# Delete this stack:
stack.delete()

Stacks class example:

from b_aws_cf.stacks import Stacks

# List all of the stacks in your account:
stacks = Stacks().list()

# Delete all of the stacks with some specific prefix:
Stacks().delete('MyPrefix')

CLI usage

The library exposes CLI commands. Run (to find about more):

cf --help

Testing

This project has integration tests based on pytest. To run tests, simply run:

pytest

Contribution

Found a bug? Want to add or suggest a new feature?
Contributions of any kind are gladly welcome. You may contact us directly, create a pull-request or an issue in github platform. Lets modernize the world together.

Release history

0.2.0

  • Raise explicit exception if stack is not found.

0.0.1

  • Initial build.

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

b_aws_cf-0.2.0.tar.gz (14.0 kB view details)

Uploaded Source

Built Distribution

b_aws_cf-0.2.0-py3-none-any.whl (15.2 kB view details)

Uploaded Python 3

File details

Details for the file b_aws_cf-0.2.0.tar.gz.

File metadata

  • Download URL: b_aws_cf-0.2.0.tar.gz
  • Upload date:
  • Size: 14.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.10

File hashes

Hashes for b_aws_cf-0.2.0.tar.gz
Algorithm Hash digest
SHA256 f0cabf3265e014e73b855438b32526c510ffe2f31ef5ec9de77b37ad00bd69ba
MD5 834ec3b4434444f90eb38e51f110ce1a
BLAKE2b-256 22f6e9cc42e5b80e4ead20dc93dac26cdd566d97089cbb6852d5e4856010c6fd

See more details on using hashes here.

File details

Details for the file b_aws_cf-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: b_aws_cf-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 15.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.10

File hashes

Hashes for b_aws_cf-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2da5b6dc75aee501a349f1cae41971469bc2add36b488e4854983a2cf10429cb
MD5 1b363bd2e0439cf937572f4681d09aaf
BLAKE2b-256 e4cf9c671b1d6e7c3352f5bcf8330a7de19f5dd36591705d57d5f2798c69b922

See more details on using hashes here.

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