poetry-template 0.1.2

A sample Python project.

Python Project Template

# Note: Install Python 3

# Note: install Poetry for Linux
$: curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python

# Note: install Poetry for Windows
$: (Invoke-WebRequest -Uri https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py -UseBasicParsing).Content | python

$: python get-poetry.py --uninstall

$: poetry install  # install all dependencies

docs

$: poetry shell
$: cd docs
# Note: review source/conf.py and source/index.rst
$: make html
# Note: see docs in docs/build/apidocs/index.html

poetry_template

$: poetry run python ./poetry_template/runner.py

tests

$: poetry run pytest

$: poetry run pytest --cov=poetry_template --cov-report=html tests
#: Note: see coverage report in htmlcov/index.html

poetry.lock

Dependencies, Python version and the virtual environment are managed by Poetry.

$: poetry search Package-Name
$: poetry add Package-Name[==Package-Version]

pyproject.toml

Define project entry point and metadata.

setup.cfg

Configure Python libraries.

Linters

$: poetry run black .

Build and publish

$: poetry config pypi-token.pypi PyPI-API-Access-Token

$: poetry publish --build