#####
Raver
#####
Ratio versioning checker.
**********
Quickstart
**********
Installation
============
Raver can be installed using ``pip install raver`` for any Python version >=3.9. Or, for
Poetry managed projects, use ``poetry add -D raver`` to add it as a development
dependency.
Using raver
===========
To just check if Raver can fetch and check your current version, use ``raver`` in your
favorite terminal while in your project directory (where ``pyproject.toml`` is).
Raver detects any Python module that is set up using Poetry by default. It will then
check if the version in the module/package's main file contains a ``__version__ = "..."``
line that matches the version in your ``pyproject.toml`` file.
Check w.r.t. git reference
--------------------------
To check the current version versus a git branch as reference (e.g. ``origin/master``),
use:
``raver --ref origin/master``
where ``origin/master`` is the reference branch. It then performs a comparison using
``git diff`` to check for committed changes. ``-r`` works as well as a shorthand.
Check changelog
---------------
To check whether a changelog entry exists for the current version. There are two
supported changelog methods, file and directory.
``raver --changelog ./path/to/changelog.rst``
where the changelog file can be of any extension. Raver checks whether the earlier
detected Python file version (only ``{major}.{minor}.{patch}``, no metadata) is included
in the document.
``raver --changelog ./path/to/changelog/``
is also allowed, where the changelog directory has to contain an entry in the format of
``v{major}.{minor}.{patch}*`` of the current version (the star is a glob wildcard).
TOML configuration
------------------
Raver supports TOML configuration! It **takes precedence over** any command-line
parameters. The following would be a sensible default for raver:
.. code-block:: toml
[tool.raver]
module = "raver" # Change to your package name or remove to use Poetry's entry.
reference = "origin/main"
changelog = "./doc/source/changelog.rst"
debug = false
***************
Developer guide
***************
Python packaging information
============================
This project is packaged using `poetry <https://python-poetry.org/>`_. Packaging
information as well as dependencies are stored in `pyproject.toml <./pyproject.toml>`_.
Installing the project and its development dependencies can be done using ``poetry install``.
Versioning
==========
This project uses `semantic versioning <https://semver.org>`_. Version increments are
checked using `Raver <https://gitlab.com/ratio-case/raver>`_.
Changelog
=========
Changelog format as described by https://keepachangelog.com/ has been adopted.
See `Changelog <./docs/source/changelog.rst>`_.
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/ratio-case/python/raver",
"name": "raver",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Ratio Innovations B.V.",
"author_email": "info@ratio-case.nl",
"download_url": "https://files.pythonhosted.org/packages/8e/7b/724f0b3136d8b1d2dbc6831e86366c2eef1a65aa59b2f2abec8be8f55440/raver-3.0.2.tar.gz",
"platform": null,
"description": "#####\nRaver\n#####\n\nRatio versioning checker.\n\n**********\nQuickstart\n**********\n\n\nInstallation\n============\n\nRaver can be installed using ``pip install raver`` for any Python version >=3.9. Or, for\nPoetry managed projects, use ``poetry add -D raver`` to add it as a development\ndependency.\n\n\nUsing raver\n===========\n\nTo just check if Raver can fetch and check your current version, use ``raver`` in your\nfavorite terminal while in your project directory (where ``pyproject.toml`` is).\n\nRaver detects any Python module that is set up using Poetry by default. It will then\ncheck if the version in the module/package's main file contains a ``__version__ = \"...\"``\nline that matches the version in your ``pyproject.toml`` file.\n\n\nCheck w.r.t. git reference\n--------------------------\n\nTo check the current version versus a git branch as reference (e.g. ``origin/master``),\nuse:\n\n``raver --ref origin/master``\n\nwhere ``origin/master`` is the reference branch. It then performs a comparison using\n``git diff`` to check for committed changes. ``-r`` works as well as a shorthand.\n\n\nCheck changelog\n---------------\n\nTo check whether a changelog entry exists for the current version. There are two\nsupported changelog methods, file and directory.\n\n``raver --changelog ./path/to/changelog.rst``\n\nwhere the changelog file can be of any extension. Raver checks whether the earlier\ndetected Python file version (only ``{major}.{minor}.{patch}``, no metadata) is included\nin the document.\n\n``raver --changelog ./path/to/changelog/``\n\nis also allowed, where the changelog directory has to contain an entry in the format of\n``v{major}.{minor}.{patch}*`` of the current version (the star is a glob wildcard).\n\n\nTOML configuration\n------------------\n\nRaver supports TOML configuration! It **takes precedence over** any command-line\nparameters. The following would be a sensible default for raver:\n\n.. code-block:: toml\n\n [tool.raver]\n module = \"raver\" # Change to your package name or remove to use Poetry's entry.\n reference = \"origin/main\"\n changelog = \"./doc/source/changelog.rst\"\n debug = false\n\n\n***************\nDeveloper guide\n***************\n\n\nPython packaging information\n============================\n\nThis project is packaged using `poetry <https://python-poetry.org/>`_. Packaging\ninformation as well as dependencies are stored in `pyproject.toml <./pyproject.toml>`_.\n\nInstalling the project and its development dependencies can be done using ``poetry install``.\n\n\nVersioning\n==========\n\nThis project uses `semantic versioning <https://semver.org>`_. Version increments are\nchecked using `Raver <https://gitlab.com/ratio-case/raver>`_.\n\n\nChangelog\n=========\n\nChangelog format as described by https://keepachangelog.com/ has been adopted.\n\nSee `Changelog <./docs/source/changelog.rst>`_.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Ratio package management tool.",
"version": "3.0.2",
"project_urls": {
"Documentation": "https://raver.ratio-case.nl",
"Homepage": "https://gitlab.com/ratio-case/python/raver",
"Repository": "https://gitlab.com/ratio-case/python/raver"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9f321cebe4e644a13cc2f736ffea51e30b0375aa0ec308f0f723c81a17b397b6",
"md5": "90fd140c7cec7f294ef46dad72ecaa20",
"sha256": "fa371de0d27bc65ab0fd403a6489975f8f0dda8198e4e0b7fc08b07c876fb29b"
},
"downloads": -1,
"filename": "raver-3.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "90fd140c7cec7f294ef46dad72ecaa20",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 8179,
"upload_time": "2023-11-21T12:49:00",
"upload_time_iso_8601": "2023-11-21T12:49:00.589583Z",
"url": "https://files.pythonhosted.org/packages/9f/32/1cebe4e644a13cc2f736ffea51e30b0375aa0ec308f0f723c81a17b397b6/raver-3.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8e7b724f0b3136d8b1d2dbc6831e86366c2eef1a65aa59b2f2abec8be8f55440",
"md5": "3b2c86b01bc60a38444c7ece85444974",
"sha256": "2a129373e591e7f2e74cc367960533c485abebe5dc2870805242210e6f64c5d5"
},
"downloads": -1,
"filename": "raver-3.0.2.tar.gz",
"has_sig": false,
"md5_digest": "3b2c86b01bc60a38444c7ece85444974",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 7598,
"upload_time": "2023-11-21T12:49:02",
"upload_time_iso_8601": "2023-11-21T12:49:02.536999Z",
"url": "https://files.pythonhosted.org/packages/8e/7b/724f0b3136d8b1d2dbc6831e86366c2eef1a65aa59b2f2abec8be8f55440/raver-3.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-21 12:49:02",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "ratio-case",
"gitlab_project": "python",
"lcname": "raver"
}
JSON