Kei18 / pypoetry-template

project template for Python-Poetry

pypoetry-template

This is a Python-Poetry template project for private research use. Some conveniences are already set up, e.g., Jupyter Lab.

setup

First, change the name "pypoetry-template" to your project name. Check:

• pyproject.toml
• pypoetry_template/
• github/workspaces/ci.yaml

Now it's ready to setup the project. Run the following command.

poetry config virtualenvs.in-project true && poetry install

Before starting development, I recommend installing pre-commit, which does large file checking, auto-formatting, etc.

pre-commit install

utilities

start jupyter lab

poetry run juypter lab

pytest

poetry run pytest -s

Notes

• GitHub Actions automatically perform pytest.
• I often write experimental scripts in scripts/.