Versionix is a lightweight Python tool that retrieves and displays the version of any standalone software — handling the many different version output formats found in the wild.
| Source: | github.com/sequana/versionix |
|---|---|
| Issues: | github.com/sequana/versionix/issues |
| Changelog: | See the Changelog section below |
Table of Contents
Many standalone tools expose their version in different ways:
- Some require
--version, some-v, and some no argument at all. - Some write to stdout, others to stderr.
- Version strings come in many formats (
1.2.3,v1.2.3,tool 1.2.3 (build ...), …).
Versionix handles all of these cases automatically. For ~80 % of tools the built-in regular-expression heuristic is enough; for the rest a curated registry of metadata ensures the right command is run and the right output channel is parsed.
- 🔍 Auto-detection — works out-of-the-box for the vast majority of tools
- 📋 Registry — curated metadata for tools with non-standard version output
- 🐍 Pure Python — no compiled dependencies; works on any platform
- ⚡ Fast — single subprocess call, minimal overhead
- 🔗 Library API — importable
get_version()function for use in your own code
Install from PyPI with pip:
pip install versionix --upgrade
No extra dependencies are required beyond the Python standard library and a handful of small pure-Python packages.
Just type versionix followed by the name of any executable on your $PATH:
versionix ls # any system command versionix fastqc # common bioinformatics tool versionix bwa
versionix prints a clean X.Y.Z version string to the terminal.
List all registered tools:
versionix --registered
Full help:
versionix --help
You can also call get_version directly from Python:
from versionix.parser import get_version
version = get_version("fastqc")
print(version) # e.g. "0.11.9"
The first difficulty is that standalone applications have different ways to obtain their
version information. Some require the use of a long or short argument (--version or
-v), while others do not require any argument at all. In addition, the display
channel (stdout or stderr) and the format of the version output differ between
applications.
To handle these various cases, Versionix uses a regular expression that covers the majority of applications. For non-standard cases, a dictionary of metadata for each registered standalone is available. These metadata specify:
- the command and options to run,
- whether to read stdout or stderr, and
- how to parse the output to extract the version string.
Versionix is designed to be used with all Sequana
pipelines and is not intended to be universal. You can add support for your own tool by
editing versionix/registry.py and opening a Pull Request.
Contributions are very welcome! Please:
- Fork the repository and create a feature branch.
- Add or update tests as appropriate.
- Open a Pull Request against
main.
Run the test suite locally with:
pytest -v --cov versionix
| Version | Description |
|---|---|
| 0.99.4 | allow introspection of apptainers |
| 0.99.3 | Maintenance release |
| 0.99.2 | Handle cases where e.g. --version is returned to the stderr (instead of stdout) |
| 0.99.1 | Remove warning if we are using registered entry. |
| 0.99.0 | Final version before 1.0.0 |
| 0.3.0 | Refactor to use regular expression and registry only if needed. This makes versionix quite generic. |
| 0.2.4 | More tools in the registry and added precommit |
| 0.2.3 | More tools in the registry |
| 0.2.2 | add all tools required by sequana pipelines (oct 2023) |
| 0.2.1 | More tools added. |
| 0.2 | simplification. Add tests. Add more tools |
| 0.1 | first draft |