Collection of helper tools for interacting with AWS Proton templates
- python3 (requires 3.7+)
- pip: https://pip.pypa.io/en/stable/installation/
On Ubuntu/Debian systems, you may also need to install the following packages:
> sudo apt-get install python3-venv python3-wheel -y
Virtual environments are recommended when working with python as it can become easy to mix up dependencies when globally managing them.
> python -m venv env
Once you activate your virtual environment, this will scope all future pip install to that environment.
# Mac
# > source env/Scripts/activate
# Linux
# > source env/bin/activate
# Windows
# > .\env\Scripts\Activate.ps1
Deactivating your virtual environment will reset to your standard shell. You will no longer have access to anything installed inside of the virtual environment.
> deactivate
> pip install .
If you see an error like invalid command 'bdist_wheel', try the following:
pip install wheel
pip install --upgrade --no-deps --force-reinstall aws-proton-template-helper
Just type the following and the command will walk you through the rest.
> aws-proton-template-helper
In this scenario you have a pre-existing tempalte that's already registered in AWS Proton and an instance of that template deployed in your account.
I'm not very well versed in windows development so this may not be the most efficient way, feel free to submit a PR with better instructions if you know them.
This assumes you have the windows python launcher set up and also that you are in the virtual environment we set up above.
> py env\Scripts\aws-proton-template-helper
You can also create a function in your powershell profile so that you don't have to remember the path every time.
function proton-helper { py C:\PATH\TO\env\Scripts\aws-proton-template-helper }
- This is currently very coupled to Cloudformation + Jinja, that should be abstracted out
See CONTRIBUTING for more information.
This project is licensed under the Apache-2.0 License.