A tool for creating python packages.
Project description
pyprote: A Python package for creating Templates for python projects
Installation from PyPi
pip install pyprote
For test-PyPi dev version:
pip install -i https://test.pypi.org/simple/ pyprote
Usage
Create a new project
Get default template:
pyprote
You will have to replace all instances of PY_PRO_TE_FILL_ME_IN
with your own project name, email etc..
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
Installation - 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
CLI app
pyprote --help
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pyprote-2022.8.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 51435ada262497a83b10dfdbdbd4dc46fd7f5db42683a7e096184144f7f2d35a |
|
MD5 | 04af17381063508a4f56cd49c274f114 |
|
BLAKE2b-256 | aff37cddf7f59dc3fc063f1e8e9a4fd55bffa5774515681cc1af920e1a2af3fc |