Skip to content

Commit f187bc2

Browse files
committed
adds features to readme
1 parent f307023 commit f187bc2

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,17 @@ pip install cookiecutter
2020
cookiecutter https://github.com/jritsema/cookiecutter-python.git
2121
```
2222

23+
## Features
24+
25+
- Scaffolds out a new directory with a new Git repo
26+
- Sets up a Python virtual environment
27+
- If you enable [direnv](https://direnv.net/) (optional), it will setup automatic activation of the virtual directory when you `cd` into it and deactivate when you leave
28+
- If you enable [asdf](https://asdf-vm.com/) (optional) it will create a `.tool-versions` file with `direnv` and `python` so that you can run `asdf install` to install required tools.
29+
- Container support: Adds a `Dockerfile` and `.dockerignore`
30+
- If you include AWS SDK, it will add it to your `requirements.txt`
31+
- Includes a `make install` command for installing dependencies and outputting a `piplock.txt` with exact versions, that can be used for reproducible builds
32+
33+
2334
## Example
2435

2536
```

0 commit comments

Comments
 (0)