Aviv CDK Python library


Keywords
aws, cdk, cdk-constructs, cdk-examples, python3
License
MIT
Install
pip install aviv-cdk==0.3.11

Documentation

AVIV CDK for Python

A set of AWS CDK examples and constructs.

Install

Requires:

  • Python >= 3.6
  • pip
pip install aviv-cdk

Extras (provides additionnal libraries, in order to build some constructs):

  • cicd - CDK codebuild/deploy
  • nextstep - Stepfunctions & co
  • data - data related stuff
pip install aviv-cdk[EXTRA]

Build, distrib & release

Requires twine to be installed (pip install twine) and credentials to upload a new verison to pypi.

python3 setup.py sdist bdist_wheel
# test distrib
python3 -m twine upload --repository testpypi dist/*

Included CDK apps / samples

Command line tools

  • aviv-aws (WIP)
    Helper to run AWS stuff locally (CDK / SAM / StepFunctionsLocal)
  • aviv-cdk-sfn-extract
    Extract a StateMachine from a CFN template

Develop and contribute :)

Requirements:

  • Pipenv
  • AWS cdk client
  • [optional] docker
  • [optional] AWS codebuild docker image (standard >= 4.0)
git clone https://github.com/aviv-group/aviv-cdk-python && cd aviv-cdk-python
pipenv install -d -e .

# Build with codebuild agent - see: buildspec.yml
codebuild_build.sh -i aws/codebuild/standard:4.0 -a cdk.out

# Run tests
pipenv run pytest -v tests/

Contribute

Yes please! Fork this project, tweak it and share it back by sending your PRs.
Have a look at the TODO's and changelog file if you're looking for inspiration.

License

This project is developed under the MIT license.

Author(s) and Contributors