Skip to main content

No project description provided

Project description

Pycracks

PyPI PyPI Downloads PyPI Version GitHub Workflow Status (with event)
Unreleased Commits Last Released date
Quality Coveralls branch Code Climate maintainability
Code Climate technical debt OSSF-Scorecard Score
Format Conventional Commits Commitlint
Pre Commit Format Linting
Legal FOSSA Status PyPI - License Commercial Use

💢🔍 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

FOSSA Status

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pycracks-0.19.0.tar.gz (9.2 kB view details)

Uploaded Source

Built Distribution

pycracks-0.19.0-py3-none-any.whl (6.6 kB view details)

Uploaded Python 3

File details

Details for the file pycracks-0.19.0.tar.gz.

File metadata

  • Download URL: pycracks-0.19.0.tar.gz
  • Upload date:
  • Size: 9.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for pycracks-0.19.0.tar.gz
Algorithm Hash digest
SHA256 51e42d05d508d6a52c25605c69e0ae2d67936f81c48b80a683275e2c6b3d3e2c
MD5 4f2015a1d60f079098f9dcde07b259ac
BLAKE2b-256 9d4e8ba831c6259a6564842a1082ae1aba97cd9a5ef1e11dec12896c90ec202a

See more details on using hashes here.

File details

Details for the file pycracks-0.19.0-py3-none-any.whl.

File metadata

  • Download URL: pycracks-0.19.0-py3-none-any.whl
  • Upload date:
  • Size: 6.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for pycracks-0.19.0-py3-none-any.whl
Algorithm Hash digest
SHA256 94671b6f0425b74f3116beaa0ff5528cb774885ef9507d2da792521c6f8495f9
MD5 b5f03df07cfde78a4ed8c5b3c0437dee
BLAKE2b-256 a7a2513f5ba6d1c3eedcba2920befbac85e2d0bb6b70585a0cfca759001b1849

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page