# Introduction

This repository is used as a prototype template for setting up new Python project.

The documentation in `docs` contains the recommended practices.

# Installation

## Requirements

- Install [pyenv](https://github.com/pyenv/pyenv#installation) to manage the Python versions
- Install [Poetry](https://python-poetry.org/docs/#installation) to manage the dependencies

Run the following command in this project root folder to install the dependencies:

```bash
poetry install
```

Or you can install the dependencies with `pip`:

```bash
pip install -r requirements.txt
```