VersionGit
==========
|code_ci| |docs_ci| |coverage| |pypi_version| |license|
.. warning::
This has been deprecated in favour of setuptools_scm and is no longer maintained
VersionGit is a tool for managing the version number of Python modules, removing
the need to update an embedded version string whenever a Git tag is made, and
providing sensible development version numbers too. It does this by storing a
single file in the source repo that reads the version from ``git describe`` or
``git archive`` keywords. At build time, this file is modified in the
distribution to contain a static version number to be used in preference to
this. This tool is inspired by versioneer_, but has a vastly reduced feature set
so that the code stored in each module is minimal.
.. _versioneer:
https://github.com/warner/python-versioneer
============== ==============================================================
PyPI ``pip install versiongit``
Source code https://github.com/dls-controls/versiongit
Documentation https://dls-controls.github.io/versiongit
Changelog https://github.com/dls-controls/versiongit/blob/master/CHANGELOG.rst
============== ==============================================================
License
-------
To make VersionGit easier to embed, all its code is dedicated to the public
domain. The ``_version_git.py`` that it creates is also in the public domain.
Specifically, both are released under the Creative Commons
"Public Domain Dedication" license (CC0-1.0)
.. |code_ci| image:: https://github.com/dls-controls/versiongit/workflows/Code%20CI/badge.svg?branch=master
:target: https://github.com/dls-controls/versiongit/actions?query=workflow%3A%22Code+CI%22
:alt: Code CI
.. |docs_ci| image:: https://github.com/dls-controls/versiongit/workflows/Docs%20CI/badge.svg?branch=master
:target: https://github.com/dls-controls/versiongit/actions?query=workflow%3A%22Docs+CI%22
:alt: Docs CI
.. |coverage| image:: https://codecov.io/gh/dls-controls/versiongit/branch/master/graph/badge.svg
:target: https://codecov.io/gh/dls-controls/versiongit
:alt: Test Coverage
.. |pypi_version| image:: https://img.shields.io/pypi/v/versiongit.svg
:target: https://pypi.org/project/versiongit
:alt: Latest PyPI version
.. |license| image:: https://img.shields.io/badge/License-CC0%201.0-blue.svg
:target: https://creativecommons.org/publicdomain/zero/1.0/
:alt: CC0-1.0 License
..
These definitions are used when viewing README.rst and will be replaced
when included in index.rst
See https://dls-controls.github.io/versiongit for more detailed documentation.
Raw data
{
"_id": null,
"home_page": "https://github.com/dls-controls/versiongit",
"name": "versiongit",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Tom Cobb",
"author_email": "tom.cobb@diamond.ac.uk",
"download_url": "https://files.pythonhosted.org/packages/0e/87/223ff61e69a1a0e651e552a0a2d9ee663cc74db13f49c796cd146afcd865/versiongit-2.2.tar.gz",
"platform": null,
"description": "VersionGit\n==========\n\n|code_ci| |docs_ci| |coverage| |pypi_version| |license|\n\n.. warning::\n\n This has been deprecated in favour of setuptools_scm and is no longer maintained\n\nVersionGit is a tool for managing the version number of Python modules, removing\nthe need to update an embedded version string whenever a Git tag is made, and\nproviding sensible development version numbers too. It does this by storing a\nsingle file in the source repo that reads the version from ``git describe`` or\n``git archive`` keywords. At build time, this file is modified in the\ndistribution to contain a static version number to be used in preference to\nthis. This tool is inspired by versioneer_, but has a vastly reduced feature set\nso that the code stored in each module is minimal.\n\n.. _versioneer:\n https://github.com/warner/python-versioneer\n\n============== ==============================================================\nPyPI ``pip install versiongit``\nSource code https://github.com/dls-controls/versiongit\nDocumentation https://dls-controls.github.io/versiongit\nChangelog https://github.com/dls-controls/versiongit/blob/master/CHANGELOG.rst\n============== ==============================================================\n\nLicense\n-------\nTo make VersionGit easier to embed, all its code is dedicated to the public\ndomain. The ``_version_git.py`` that it creates is also in the public domain.\nSpecifically, both are released under the Creative Commons\n\"Public Domain Dedication\" license (CC0-1.0)\n\n.. |code_ci| image:: https://github.com/dls-controls/versiongit/workflows/Code%20CI/badge.svg?branch=master\n :target: https://github.com/dls-controls/versiongit/actions?query=workflow%3A%22Code+CI%22\n :alt: Code CI\n\n.. |docs_ci| image:: https://github.com/dls-controls/versiongit/workflows/Docs%20CI/badge.svg?branch=master\n :target: https://github.com/dls-controls/versiongit/actions?query=workflow%3A%22Docs+CI%22\n :alt: Docs CI\n\n.. |coverage| image:: https://codecov.io/gh/dls-controls/versiongit/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/dls-controls/versiongit\n :alt: Test Coverage\n\n.. |pypi_version| image:: https://img.shields.io/pypi/v/versiongit.svg\n :target: https://pypi.org/project/versiongit\n :alt: Latest PyPI version\n\n.. |license| image:: https://img.shields.io/badge/License-CC0%201.0-blue.svg\n :target: https://creativecommons.org/publicdomain/zero/1.0/\n :alt: CC0-1.0 License\n\n..\n These definitions are used when viewing README.rst and will be replaced\n when included in index.rst\n\nSee https://dls-controls.github.io/versiongit for more detailed documentation.\n\n\n",
"bugtrack_url": null,
"license": "CC0 1.0",
"summary": "Tool for adding version from git to a python project without adding dependencies",
"version": "2.2",
"project_urls": {
"Homepage": "https://github.com/dls-controls/versiongit"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e08872ac51d95a70c07d19dba4f09836a46651cc37a9c75f2c2017615ab06fb6",
"md5": "bea39f991ad5138b5c2d317af007e620",
"sha256": "383ecc9a9a19f2e757abe17c22e95e9f82814bbdd68774b3aac07ec4275c3344"
},
"downloads": -1,
"filename": "versiongit-2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bea39f991ad5138b5c2d317af007e620",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 8801,
"upload_time": "2023-12-15T16:30:51",
"upload_time_iso_8601": "2023-12-15T16:30:51.701428Z",
"url": "https://files.pythonhosted.org/packages/e0/88/72ac51d95a70c07d19dba4f09836a46651cc37a9c75f2c2017615ab06fb6/versiongit-2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0e87223ff61e69a1a0e651e552a0a2d9ee663cc74db13f49c796cd146afcd865",
"md5": "473b1124cd18efb21967f651ff3f6332",
"sha256": "45817c355c6a0ca4a21af15d451d444b3bc5cf03f374cb72907174f3f6043daf"
},
"downloads": -1,
"filename": "versiongit-2.2.tar.gz",
"has_sig": false,
"md5_digest": "473b1124cd18efb21967f651ff3f6332",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5380,
"upload_time": "2023-12-15T16:30:52",
"upload_time_iso_8601": "2023-12-15T16:30:52.737160Z",
"url": "https://files.pythonhosted.org/packages/0e/87/223ff61e69a1a0e651e552a0a2d9ee663cc74db13f49c796cd146afcd865/versiongit-2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-15 16:30:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dls-controls",
"github_project": "versiongit",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "versiongit"
}
JSON
