sammck/aws-dev-box-template

A python cookiecutter template for a project that manages a bunch of AWS resources including a development EC2 instance

aws-dev-box-template: A Python package

Python package aws-dev-box-template

Table of contents

• Introduction
• Installation
• Usage
  • API
• Known issues and limitations
• Getting help
• Contributing
• License
• Authors and history

Introduction

Python package aws-dev-box-template BLAH BLAH.

Installation

Prerequisites

Python: Python 3.8+ is required. See your OS documentation for instructions.

From PyPi

The current released version of aws-dev-box-template can be installed with

pip3 install aws-dev-box-template

From GitHub

Poetry is required; it can be installed with:

curl -sSL https://install.python-poetry.org | python3 -

Clone the repository and install aws-dev-box-template into a private virtualenv with:

cd <parent-folder>
git clone https://github.com/sammck/aws-dev-box-template.git
cd aws-dev-box-template
poetry install

You can then launch a bash shell with the virtualenv activated using:

poetry shell

Usage

API

TBD

Known issues and limitations

Getting help

Please report any problems/issues here.

Contributing

Pull requests welcome.

License

aws-dev-box-template is distributed under the terms of the MIT License. The license applies to this file and other files in the Git repository hosting this file.

Authors and history

The author of aws-dev-box-template is Sam McKelvie.