foundation

This repository serves as a template with configuration files for common python tools, including poetry, pre-commit, black, isort, etc.

Development setup

Recommend to use Miniconda to create a virtual environment:

$ conda create --name foundation python=3.9
# Answer yes to the prompt
$ conda activate foundation

Whenever you work on this you can activate the environment again using:

$ conda activate foundation

The project is set up using the poetry dependency management tool.

For Linux, macOS, and Windows (WSL):

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

An alternative way for macOS is:

$ brew install poetry

$ poetry install
# Initialize pre-commit hooks
$ pre-commit install

Run test cases with:

$ pytest -n 8

Collect some useful code snippets from following repositories with nicely modification: