No project description provided
Project description
Pycracks
PyPI | |
---|---|
Quality | |
Format | |
Legal |
💢🔍 breaking change detection in Python - Compatible with Semantic Version and Semantic Release
Usage
Use the --help flag for detailed options:
pycracks --help
Pycracks can be used in different ways, the most straightforward one is:
pycracks --paths "tests" --target-version "<to-be-release-version>" --test-command "pytest tests"
The test-command
could be any command and does not need to be Python specific
Combine with scripts
It is also possible to simplify the test-command
by always using something like pipenv scripts
or npm scripts
So in the project.json
/ Pipfile
, one could define the test command and use pycracks with npm run test
or pipenv run test
instead:
pycracks --paths "tests" --target-version "<to-be-release-version>" --test-command "pipenv run test"
pycracks --paths "tests" --target-version "<to-be-release-version>" --test-command "npm run test"
Semantic Release
If using the Python-Semantic-Release module, installable with:
pipx install python-semantic-release
One can integrate it with PyCracks by using:
pycracks -t "$(semantic-release -v version --print)"
Installation
With Pipx
Recommended instalation for CICD is through pipx
with a pinned version:
pip install pipx==1.2.0
pipx run pycracks==0.18.0 --paths "tests" --target-version "<to-be-release-version>" --test-command "pytest tests"
That command will create a virtual environment just for pycracks and run the test command from there.
With pip
Instalation can be done with pip as usual:
pip install pycracks
Pipenv and poetry equivalents can be used as well.
F.A.Q.
License
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 pycracks-0.20.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4572b43c65ac6b9510dd33639f74a1c3f27c3ff253571939e949b0b5984c6ffc |
|
MD5 | 57d1cd6988e0cfe974aff5ba71c5c0e3 |
|
BLAKE2b-256 | 99cddfd4868f4b0f3a15652bc2a3724ea29b42f2e15d90c6fc22882081cb29b0 |