Install

pip3 install cleaning-utils

Contributing

Testing:

make install
make test && make coverage && make check-codestyle && make mypy && make check-safety && make extrabadges

Checks on various versions:

python3.8 -m venv .venv_38
. .venv_38/bin/activate
python3 -m pip install --upgrade pip
make install
make test && make coverage && make check-codestyle && make mypy && make check-safety
deactivate

python3.9 -m venv .venv_39
. .venv_39/bin/activate
python3 -m pip install --upgrade pip
make install
make test && make coverage && make check-codestyle && make mypy && make check-safety
deactivate

Build Package:

pre-commit run --all-files

First, change the version in setup.py, pyproject.toml, and change the __version__ in __init__.py. Then:

python3 setup.py sdist bdist_wheel

Commit Changes:

pre-commit run --all-files
git add .
git commit -m ":sparkles: new feature"
git pull
git push -u origin master

Make a release:

git tag -a <write the version e.g., v0.1.2> -m "message of release"
git push --tags
make release

Commit Changes to README.md:

pre-commit run --all-files
git add .
git commit -m ":books: README.md updated"
git pull
git push -u origin master

Credits

This project was generated with python-package-template