After creating a new git repository copy over: * docs * poetry_template * tests * pyproject.toml * README.md Go through the project and change the placeholder values. pyproject.toml contains the list of the most important values present throughout the project. Finally, delete this note. # Note: Install Python 3 # You may also need to install or update pip, virtualenv (dependency encapsulator) and black (linter) # Note: install Poetry for your OS # Note: `.toml` project name and package have to match (poetry-template; poetry_template) $: poetry install # install all dependencies $: pip install dist/poetry_template-0.1.5-py3-none.any.whl $: poetry-template $: 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 run poetry-template --help $: poetry run python ./poetry_template/runner.py --help $: poetry run python ./poetry_template/runner.py -x 2 -y -1 -tuple A B C -list D -list E -list F -move rock $: poetry run pytest --durations=0 $: poetry run pytest --cov=poetry_template --cov-report=html tests # Note: see coverage report in htmlcov/index.html # Note: exclude directories from coverage report through .coveragerc Dependencies, Python version and the virtual environment are managed by Poetry.
$: poetry search Package-Name $: poetry add [-D] Package-Name[==Package-Version] Define project entry point and metadata.
$: poetry run black . $: poetry run mypy ./poetry_template ./tests $: poetry run python ./poetry_template/profiler.py $: poetry build # Note: get the token from your PiPy account $: poetry config pypi-token.pypi PyPI-Api-Access-Token $: poetry publish --build https://pypi.org/project/poetry-template/