Skip to main content

Aviv CDK Python library

Project description

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

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

aviv-cdk-0.1.0rc5.tar.gz (16.2 kB view hashes)

Uploaded Source

Built Distribution

aviv_cdk-0.1.0rc5-py3-none-any.whl (22.4 kB view hashes)

Uploaded Python 3

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