Skip to content

Commit

Permalink
adds features to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jritsema committed Nov 30, 2024
1 parent f307023 commit f187bc2
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,17 @@ pip install cookiecutter
cookiecutter https://github.com/jritsema/cookiecutter-python.git
```

## Features

- Scaffolds out a new directory with a new Git repo
- Sets up a Python virtual environment
- 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
- 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.
- Container support: Adds a `Dockerfile` and `.dockerignore`
- If you include AWS SDK, it will add it to your `requirements.txt`
- Includes a `make install` command for installing dependencies and outputting a `piplock.txt` with exact versions, that can be used for reproducible builds


## Example

```
Expand Down

0 comments on commit f187bc2

Please sign in to comment.