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.3a1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e04b46c5eec1e82eff15a720c69e69eb415840b0717527857f96b65f24456d66 |
|
MD5 | 1488ae26d03941f348ec3cd9f1a751ff |
|
BLAKE2b-256 | 92e4c37c9df9ce6852eba24affdc258c50bd5fd78f3ad95d4a544ffa21a83990 |
Hashes for proman_versioning-0.4.3a1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 143577df330aebde030b8efc12ed6d56f1dc2b0da54bb99bba6fa3e17d15bad1 |
|
MD5 | f94f18c6072391edb4d5b15849adb8dc |
|
BLAKE2b-256 | 1265fd9c81d12ab7eb8640aea94fa01914b43b496808f6ab7e834092244594a0 |