| Name | check-bump JSON |
| Version |
1.0.0
JSON |
| download |
| home_page | None |
| Summary | Do not allow prints in your code |
| upload_time | 2024-03-29 10:07:57 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
versioning
check
ci
cd
version
bump
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<p align="center"></p>
<h2 align="center">Check Bump</h2>
<p align="center">
<a href="https://github.com/rgryta/Check-Bump/actions/workflows/main.yml"><img alt="Build" src="https://github.com/rgryta/Check-Bump/actions/workflows/main.yml/badge.svg?branch=main"></a>
<a href="https://pypi.org/project/check-bump/"><img alt="PyPI" src="https://img.shields.io/pypi/v/check-bump"></a>
<a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
<a href="https://github.com/PyCQA/pylint"><img alt="pylint" src="https://img.shields.io/badge/linting-pylint-yellowgreen"></a>
<a href="https://github.com/rgryta/NoPrint"><img alt="NoPrint" src="https://img.shields.io/badge/NoPrint-enabled-blueviolet"></a>
</p>
## About
Want to add version bump checks to your CI/CD pipeline? This packages makes it easy.
Simply execute `check-vbump` within a directory where your `pyproject.toml` is located.
If there was a version bump, process will finish with exit code 0 - read stdout for the new version.
Otherwise, process will finish with exit code 1.
## Requirements
This package requires `tomlkit` package.
## Usage
Simply execute `check-bump` within a directory where your `pyproject.toml` is located. Or provide a path using `--path` argument.
```bash
user$ check-bump --help
usage: check-bump [-h] [-p PATH]
Detect and retrieve version bump
options:
-h, --help show this help message and exit
-p PATH, --path PATH path to pyproject.toml file
```
## Development
### Installation
Install virtual environment and check_bump package in editable mode with dev dependencies.
```bash
python -m venv venv
source venv/bin/activate
pip install -e .[dev]
```
### Formatting
Use black and isort (with black profile) to format the code.
```bash
isort .
black .
```
### Syntax checks
Use pylint to check the code for errors and potential problems.
Also use noprint to detect print statements in the code (use logging instead!).
```bash
isort -c .
black --check .
pylint check_bump tests
noprint -ve check_bump tests
```
### Testing
For testing use coverage with pytest workers - this is due to errors that pytest-cov sometimes has with Python 3.9 and above.
```bash
coverage run -m pytest -xv tests
coverage report -m --fail-under=30
coverage erase
```
### Clean up
Clean up the project directory from temporary files and directories. Purge virual environment.
```bash
coverage erase
rm -rf check_bump.egg-info/ dist/ build/
rm -rf venv/
```
Raw data
{
"_id": null,
"home_page": null,
"name": "check-bump",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "versioning, check, CI, CD, version, bump",
"author": null,
"author_email": "Radoslaw Gryta <radek.gryta@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/c0/9d/458f4a02d367a0423d9017356cd1b4a107f221a9f8893474d291cf70ce81/check-bump-1.0.0.tar.gz",
"platform": null,
"description": "<p align=\"center\"></p>\n<h2 align=\"center\">Check Bump</h2>\n<p align=\"center\">\n<a href=\"https://github.com/rgryta/Check-Bump/actions/workflows/main.yml\"><img alt=\"Build\" src=\"https://github.com/rgryta/Check-Bump/actions/workflows/main.yml/badge.svg?branch=main\"></a>\n<a href=\"https://pypi.org/project/check-bump/\"><img alt=\"PyPI\" src=\"https://img.shields.io/pypi/v/check-bump\"></a>\n<a href=\"https://github.com/psf/black\"><img alt=\"Code style: black\" src=\"https://img.shields.io/badge/code%20style-black-000000.svg\"></a>\n<a href=\"https://github.com/PyCQA/pylint\"><img alt=\"pylint\" src=\"https://img.shields.io/badge/linting-pylint-yellowgreen\"></a>\n<a href=\"https://github.com/rgryta/NoPrint\"><img alt=\"NoPrint\" src=\"https://img.shields.io/badge/NoPrint-enabled-blueviolet\"></a>\n</p>\n\n## About\n\nWant to add version bump checks to your CI/CD pipeline? This packages makes it easy.\nSimply execute `check-vbump` within a directory where your `pyproject.toml` is located.\n\nIf there was a version bump, process will finish with exit code 0 - read stdout for the new version.\nOtherwise, process will finish with exit code 1.\n\n## Requirements\n\nThis package requires `tomlkit` package.\n\n## Usage\n\nSimply execute `check-bump` within a directory where your `pyproject.toml` is located. Or provide a path using `--path` argument.\n\n```bash\nuser$ check-bump --help\nusage: check-bump [-h] [-p PATH]\n\nDetect and retrieve version bump\n\noptions:\n -h, --help show this help message and exit\n -p PATH, --path PATH path to pyproject.toml file\n```\n\n## Development\n\n### Installation\n\nInstall virtual environment and check_bump package in editable mode with dev dependencies.\n\n```bash\npython -m venv venv\nsource venv/bin/activate\npip install -e .[dev]\n```\n\n\n### Formatting\n\nUse black and isort (with black profile) to format the code.\n\n```bash\nisort .\nblack .\n```\n\n### Syntax checks\n\nUse pylint to check the code for errors and potential problems.\nAlso use noprint to detect print statements in the code (use logging instead!).\n\n```bash\nisort -c .\nblack --check .\npylint check_bump tests\nnoprint -ve check_bump tests\n```\n\n### Testing\n\nFor testing use coverage with pytest workers - this is due to errors that pytest-cov sometimes has with Python 3.9 and above.\n\n```bash\ncoverage run -m pytest -xv tests\ncoverage report -m --fail-under=30\ncoverage erase\n```\n\n### Clean up\n\nClean up the project directory from temporary files and directories. Purge virual environment.\n\n```bash\ncoverage erase\nrm -rf check_bump.egg-info/ dist/ build/\nrm -rf venv/\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "Do not allow prints in your code",
"version": "1.0.0",
"project_urls": {
"Bug Tracker": "https://github.com/rgryta/Check-Bump/issues",
"Homepage": "https://github.com/rgryta/Check-Bump"
},
"split_keywords": [
"versioning",
" check",
" ci",
" cd",
" version",
" bump"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8f4f79429cfc3ccfedd5e6576bb683b862a36d8ae64d4c83921ee9afffe1c51f",
"md5": "86378a7b3d293a6733912a8f60df5c0f",
"sha256": "16b03d6ba462bd216ea5540af0b778442565b23eb9c4f308842cc05c65d0ee47"
},
"downloads": -1,
"filename": "check_bump-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "86378a7b3d293a6733912a8f60df5c0f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 4885,
"upload_time": "2024-03-29T10:07:56",
"upload_time_iso_8601": "2024-03-29T10:07:56.494700Z",
"url": "https://files.pythonhosted.org/packages/8f/4f/79429cfc3ccfedd5e6576bb683b862a36d8ae64d4c83921ee9afffe1c51f/check_bump-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c09d458f4a02d367a0423d9017356cd1b4a107f221a9f8893474d291cf70ce81",
"md5": "055da83230c8ba62250993be8fcf8803",
"sha256": "2baef1b901488e02d4741243cb85cc3c44a715c162705864b3f9bb4cd7be8a94"
},
"downloads": -1,
"filename": "check-bump-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "055da83230c8ba62250993be8fcf8803",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 5084,
"upload_time": "2024-03-29T10:07:57",
"upload_time_iso_8601": "2024-03-29T10:07:57.947965Z",
"url": "https://files.pythonhosted.org/packages/c0/9d/458f4a02d367a0423d9017356cd1b4a107f221a9f8893474d291cf70ce81/check-bump-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-29 10:07:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "rgryta",
"github_project": "Check-Bump",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "check-bump"
}
