Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/m-vdb/pep440-version-utils
Utilities to deal with pep440 versioning
https://github.com/m-vdb/pep440-version-utils
Last synced: about 1 month ago
JSON representation
Utilities to deal with pep440 versioning
- Host: GitHub
- URL: https://github.com/m-vdb/pep440-version-utils
- Owner: m-vdb
- License: mit
- Created: 2020-05-16T06:30:57.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-08-29T14:33:24.000Z (4 months ago)
- Last Synced: 2024-11-08T14:42:13.027Z (about 2 months ago)
- Language: Python
- Size: 172 KB
- Stars: 7
- Watchers: 2
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://coveralls.io/github/m-vdb/pep440-version-utils?branch=main)
# pep440-version-utils
This package regroups utilities to deal with pep440 versioning. It is based on the
[PyPA's `packaging`](https://github.com/pypa/packaging) project and extends it.
It makes it easier to handle version bumps and strictly follows [PEP440 specification](https://www.python.org/dev/peps/pep-0440/).
## Installation
Use `pip` or `poetry` to install this package:
```bash
$ pip install pep440-version-utils
# or alternatively
$ poetry add pep440-version-utils
```
## Usage
Since this package extends the `packaging` library, so it supports version parsing and ordering as described
in [this documentation](https://packaging.pypa.io/en/latest/version/).
To bump to a new release version:
```python
from pep440_version_utils import Version
version = Version("1.10.2")
version.next_micro() # 1.10.3
version.next_minor() # 1.11.0
version.next_major() # 2.0.0
```
To bump to a new prerelease version:
```python
from pep440_version_utils import Version
version = Version("1.10.2")
version.next_alpha() # 1.10.3a1
version.next_beta() # 1.10.3b1
version.next_release_candidate() # 1.10.3rc1
version.next_alpha("minor") # 1.11.0a1
version.next_beta("mior") # 1.11.0b1
version.next_release_candidate("major") # 2.0.0rc1
```
And it implements the full release cycle:
```python
from pep440_version_utils import Version
version = Version("1.10.2")
alpha1 = version.next_alpha() # 1.10.3a1
alpha2 = alpha1.next_alpha() # 1.10.3a2
beta1 = alpha2.next_beta() # 1.10.3b1
rc1 = beta1.next_release_candidate() # 1.10.3rc1
rc2 = rc1.next_release_candidate() # 1.10.3rc2
new_version = rc2.next_micro() # 1.10.3
```
You can also check if a version is a specific type of prerelease:
```python
from pep440_version_utils import Version
Version("1.10.2a1").is_alpha # True
Version("1.10.2b2").is_beta # True
Version("1.10.2rc1").is_release_candidate # True
```
## Limitations
This package doesn't support _post_ and _local_ versions yet. **Contributions are welcome 😊**
## How to contribute
This package is fairly simple, here is how you can contribute:
1. ⚙️ Install [`poetry`](https://python-poetry.org/)
2. 📦 In the repository folder, run `poetry install`
3. ✍️ Implement the desired changes
4. ✅ Run test, type checking and code quality checks:
```bash
$ poetry run black . --check
$ poetry run mypy */**.py --ignore-missing-imports
$ poetry run pytest --cov=pep440_version_utils
```
5. ➡️ Submit a new pull request
Do not hesitate to contribue, even for very small changes!
## How to release new versions
1. Update CHANGELOG
2. Update project version in `pyproject.toml`
3. `poetry build`
4. `poetry publish`