pyprote: A Python package for creating Templates for python projects

Installation from PyPi

pip install pyprote

Usage

You can create a project template by changing into the directory you want the template to be created in. Existing files will not be overwritten.

Create a new project

Use default template:

You will have to replace all instances of PY_PRO_TE_FILL_ME_IN with your own project name, email etc..

pyprote

Fill the template cli arguments:

pyprote --package_name my_cool_package_name \
        --package_version 0.1.0 \
        --package_description 'My cool package description' \
        --package_author_name 'John Doe' \
        --package_author_email john@doe \
        --package_link https://cool.package \
        --out_dir pyprote_output_dir

CLI app

pyprote --help

Installation - local development

Create a virtual environment.

Poetry:

poetry install

Testing

Running the tests requires to run the following command in the root folder (of course in the virtual environment):

poetry run pytest

Formatting

poetry run black . && \
poetry run isort . && \
poetry run flake8 . && \
poetry run mypy .

Versioning

Update (calendar) version with bumpver:

poetry run bumpver update --dry --patch

--dry just shows how the version WOULD change.

poetry run bumpver update --patch

How to build a Python package?

To build the package, you need to go to the root folder of the package and run the following command:

poetry build

The built package is now located in the dist/ folder.

Publishing your package in PyPi

Publishing is done automatically using GitHub actions.

Commit to master creates test-pypi release.

Tagged Commit creates real pypi release.

Cattes/pyprote