Project Manager Versioning tool.
Project description
Proman Versioning
Overview
Project Manager Versioning is a PEP-440 compliant tool for automating project versions using conventional commits.
Install
pip install proman-versioning
Setup
This tool is designed to work with any textfile using a templating pattern and path to the file.
Configuring versions
Configuration can be performed with either the .versioning
or pyproject.toml
files.
Global configuration settings:
Specific types of releases can be disabled by setting the respective release to false.
Disable development releases:
enable_devreleases = false
Disable pre-releases:
enable_prereleases = false
Disable post-releases:
enable_postreleases = false
File specific settings:
Use different version compatibiliy type:
compat = "semver"
Update only the release version for a configuration:
release_only = true
Example .versioning
The .versioning
config is a non-specfile based project file using TOML. This is the
preferred configuration for non-python projects that may use this tool.
[proman]
version = "1.2.3"
[proman.versioning]
disable_devreleases = true
[[tool.proman.versioning.files]]
filepath = "pyproject.toml"
pattern = "version = \"${version}\""
[[proman.versioning.files]]
filepath = "example/__init__.py"
pattern = "__version__ = '${version}'"
Example pyproject.toml
[tool.proman]
version = "1.2.3"
[tool.proman.versioning]
[[tool.proman.versioning.files]]
filepath = "pyproject.toml"
pattern = "version = \"${version}\""
[[tool.proman.versioning.files]]
filepath = "example/__init__.py"
pattern = "__version__ = '${version}'"
Example setup.cfg
Setuptools allows setup.cfg
to pull the version from the application. This
should be used in tandem with either of the above configurations to control
versions for a project.
[metadata]
name = example
version = attr: src.VERSION
...
References
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 proman-versioning-0.4.0a0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c634db20452ebb5086fc81a78835eff18062e2342ff804e92b77604f5f2f6f6c |
|
MD5 | 33313a57d18ea130606d9fd94280bae6 |
|
BLAKE2b-256 | f7175ba0d39d29aab98e11f14c293e6fc3b97a1280f82a9171bb7b9b19ee2ffc |
Hashes for proman_versioning-0.4.0a0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6e7b3dc8154fe4a345252ee7ef88bf683b39f18e917045af711add32a3fae0c9 |
|
MD5 | cdb2d1a15c980cc44c032c2d7f272715 |
|
BLAKE2b-256 | 73e5dddd45f04701fb9da6145a3069c61fef11a36296344762bf3c53492aec52 |