Versionix
###########
.. image:: https://badge.fury.io/py/versionix.svg
:target: https://pypi.python.org/pypi/versionix
.. image:: https://github.com/sequana/versionix/actions/workflows/main.yml/badge.svg
:target: https://github.com/sequana/versionix/actions/workflows/main.yml
.. image:: https://coveralls.io/repos/github/sequana/versionix/badge.svg?branch=main
:target: https://coveralls.io/github/sequana/versionix?branch=main
.. image:: https://zenodo.org/badge/658721856.svg
:target: https://zenodo.org/badge/latestdoi/658721856
:Python version: Python 3.8, 3.9, 3.10, 3.11, 3.12
:Source: See `http://github.com/sequana/versionix <https://github.com/sequana/versionix/>`__.
:Issues: Please fill a report on `github <https://github.com/sequana/versionix/issues>`__
Overview
========
Versionix is a simple tool that attemps to print on screen the version of a given standalone.
Installation
----------------
If you are in a hurry, just type::
pip install versionix --upgrade
This is pure Python so no need for fancy libraries.
Usage
-----
Then, just type **versionix** followed by an executable installed on your system, e.g for linux users::
versionix ls
where **ls** is a standard command. In bioinformatics, **fastqc** is quite common. You can check its version as
follows::
versionix fastqc
**versionix** prints the version as X.Y.Z string.
Most tools would work. However, a registry is available for complex cases. Registered tools can be obtained with the following command. If your favorite tool is not there, create a PR or an issue::
versionix --registered
Type::
versionix --help
to get more help like this example:
.. image:: doc/versionix_usage.png
DESCRIPTION
===========
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, display channels (stdout or stderr) and formats of the version output differs between applications. To handle these various cases, we define a regular expression that should work for maybe 80% of applications (difficult to estimate). For non standard case, a dictionnary of **metadata** related to the different standalones is available. These metadata helps in the identification of the command to run, the options to use, if the information is directed to stdout or stderr and the method to parse the output to obtain the version number.
Versionix is designed to be used with all Sequana pipelines and is not intended to be universal. You can add your own standalone version in the versionix/register.py file and provide a Pull Request.
Changelog
=========
========= ========================================================================
Version Description
========= ========================================================================
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
make 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
========= ========================================================================
Raw data
{
"_id": null,
"home_page": "https://github.com/sequana/versionix",
"name": "versionix",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "versioning, bioinformatics",
"author": "Sequana Team",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/73/20/a1cc25d769ff17ad193481a555adf1f5bad4b58ffa2477eea814b392da11/versionix-0.99.1.tar.gz",
"platform": null,
"description": "Versionix\n###########\n\n\n.. image:: https://badge.fury.io/py/versionix.svg\n :target: https://pypi.python.org/pypi/versionix\n\n\n.. image:: https://github.com/sequana/versionix/actions/workflows/main.yml/badge.svg\n :target: https://github.com/sequana/versionix/actions/workflows/main.yml\n\n.. image:: https://coveralls.io/repos/github/sequana/versionix/badge.svg?branch=main\n :target: https://coveralls.io/github/sequana/versionix?branch=main\n\n.. image:: https://zenodo.org/badge/658721856.svg\n :target: https://zenodo.org/badge/latestdoi/658721856\n\n:Python version: Python 3.8, 3.9, 3.10, 3.11, 3.12\n:Source: See `http://github.com/sequana/versionix <https://github.com/sequana/versionix/>`__.\n:Issues: Please fill a report on `github <https://github.com/sequana/versionix/issues>`__\n\nOverview\n========\n\nVersionix is a simple tool that attemps to print on screen the version of a given standalone.\n\nInstallation\n----------------\n\nIf you are in a hurry, just type::\n\n pip install versionix --upgrade\n\nThis is pure Python so no need for fancy libraries.\n\nUsage\n-----\n\nThen, just type **versionix** followed by an executable installed on your system, e.g for linux users::\n\n versionix ls\n\nwhere **ls** is a standard command. In bioinformatics, **fastqc** is quite common. You can check its version as\nfollows::\n\n versionix fastqc\n\n**versionix** prints the version as X.Y.Z string.\n\nMost tools would work. However, a registry is available for complex cases. Registered tools can be obtained with the following command. If your favorite tool is not there, create a PR or an issue::\n\n versionix --registered\n\nType::\n\n versionix --help\n\nto get more help like this example:\n\n.. image:: doc/versionix_usage.png\n\n\nDESCRIPTION\n===========\n\n\nThe 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, display channels (stdout or stderr) and formats of the version output differs between applications. To handle these various cases, we define a regular expression that should work for maybe 80% of applications (difficult to estimate). For non standard case, a dictionnary of **metadata** related to the different standalones is available. These metadata helps in the identification of the command to run, the options to use, if the information is directed to stdout or stderr and the method to parse the output to obtain the version number.\n\nVersionix is designed to be used with all Sequana pipelines and is not intended to be universal. You can add your own standalone version in the versionix/register.py file and provide a Pull Request.\n\n\nChangelog\n=========\n\n========= ========================================================================\nVersion Description\n========= ========================================================================\n0.99.1 Remove warning if we are using registered entry.\n0.99.0 Final version before 1.0.0\n0.3.0 Refactor to use regular expression and registry only if needed. This\n make versionix quite generic.\n0.2.4 More tools in the registry and added precommit\n0.2.3 More tools in the registry\n0.2.2 add all tools required by sequana pipelines (oct 2023)\n0.2.1 More tools added.\n0.2 simplification. Add tests. Add more tools\n0.1 first draft\n========= ========================================================================\n",
"bugtrack_url": null,
"license": "BSD-3",
"summary": "Get version of any tools",
"version": "0.99.1",
"project_urls": {
"Homepage": "https://github.com/sequana/versionix",
"Repository": "https://github.com/sequana/versionix"
},
"split_keywords": [
"versioning",
" bioinformatics"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2035a2b525574774411e376f1a6f8c4fb455b7f8820a03b0ecdb2e296a3a4b94",
"md5": "cbcd2d2e9b4089e9ebce0ef2cf097a53",
"sha256": "c1c45c3250593597d32113bbca9d72ea2577f1d364277a16d6673c91c2943498"
},
"downloads": -1,
"filename": "versionix-0.99.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cbcd2d2e9b4089e9ebce0ef2cf097a53",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 9646,
"upload_time": "2024-10-10T08:15:49",
"upload_time_iso_8601": "2024-10-10T08:15:49.105620Z",
"url": "https://files.pythonhosted.org/packages/20/35/a2b525574774411e376f1a6f8c4fb455b7f8820a03b0ecdb2e296a3a4b94/versionix-0.99.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7320a1cc25d769ff17ad193481a555adf1f5bad4b58ffa2477eea814b392da11",
"md5": "ea6fd0228893586707a8b1217d6af19f",
"sha256": "022f28a65406b34160c1ad27c543ac0167f0bcacb960dcb9ca00bc588a425304"
},
"downloads": -1,
"filename": "versionix-0.99.1.tar.gz",
"has_sig": false,
"md5_digest": "ea6fd0228893586707a8b1217d6af19f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 8871,
"upload_time": "2024-10-10T08:15:51",
"upload_time_iso_8601": "2024-10-10T08:15:51.076839Z",
"url": "https://files.pythonhosted.org/packages/73/20/a1cc25d769ff17ad193481a555adf1f5bad4b58ffa2477eea814b392da11/versionix-0.99.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-10 08:15:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sequana",
"github_project": "versionix",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "versionix"
}
JSON
