Version handling

.circleci/config.yml

@@ -61,6 +61,9 @@ commands:
       - run:
           name: Check with pylint
           command: poetry run pylint --disable=R gvm
+      - run:
+          name: Check version information
+          command: poetry run python -m gvm.version verify current
   deploy:
     description: "Upload package to PyPI"
     steps:
@@ -70,7 +73,7 @@ commands:
           command: poetry install --no-dev
       - run:
           name: Verify tag version
-          command: poetry run python verify-version.py ${CIRCLE_TAG}
+          command: poetry run python -m gvm.version verify ${CIRCLE_TAG}
       - run:
           name: Install twine
           command: poetry run pip install twine

CHANGELOG.md

@@ -7,8 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [unreleased]
 
+### Added
+* Added an API and CLI utilities for the version handling in python-gvm
+  [#198](https://github.com/greenbone/python-gvm/pull/198)
+
 ### Changed
-- Replaced `pipenv` with `poetry` for dependency management. `poetry install`
+* Replaced `pipenv` with `poetry` for dependency management. `poetry install`
   works a bit different then `pipenv install`. It installs dev packages by
   default and also python-gvm in editable mode. This means after running
   `poetry install` gvm will directly be importable in the virtual python

RELEASE.md

@@ -21,9 +21,23 @@ release. We are following [Semantic Versioning](https://semver.org/) and
   git checkout -b create-new-release upstream/master
   ```
 
-* Open `pyproject.toml` and increment the version number. For example, if the
-  file contains `version = 22.4dev1`, the line should be changed to
-  `version = 22.4`.
+* Get the current version number
+
+  ```sh
+  poetry run python -m gvm.version show
+  ```
+
+* Determine new release version number
+
+  If the output is something like  `22.4.dev1` or `21.10a1`, the new version
+  should be `22.4` or `21.10` respectively.
+
+* Update to new version number (`<new-version>` must be replaced by the version
+  from the last step)
+
+  ```sh
+  poetry run python -m gvm.version update <new-version>
+  ```
 
 * Update the `CHANGELOG.md` file:
   * Change `[unreleased]` to new release version.

gvm/__init__.py

@@ -18,23 +18,7 @@
 """
 Main module of python-gvm.
 """
-from pathlib import Path
-
-from pkg_resources import safe_version
-
-import toml
-
-
-def get_version_from_pyproject_toml() -> str:
-    path = Path(__file__)
-    pyproject_toml_path = path.parent.parent / 'pyproject.toml'
-
-    if pyproject_toml_path.exists():
-        pyproject_toml = toml.loads(pyproject_toml_path.read_text())
-        if 'tool' in pyproject_toml and 'poetry' in pyproject_toml['tool']:
-            return pyproject_toml['tool']['poetry']['version']
-
-    raise RuntimeError('Version information not found in pyproject.toml file.')
+from .__version__ import __version__
 
 
 def get_version() -> str:
@@ -47,5 +31,4 @@ def get_version() -> str:
     .. _PEP440:
        https://www.python.org/dev/peps/pep-0440
     """
-    str_version = get_version_from_pyproject_toml()
-    return safe_version(str_version)
+    return __version__

gvm/__version__.py

@@ -0,0 +1,5 @@
+# pylint: disable=invalid-name
+
+# THIS IS AN AUTOGENERATED FILE. DO NOT TOUCH!
+
+__version__ = "20.4.dev1"

gvm/utils.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# Copyright (C) 2018 - 2019 Greenbone Networks GmbH
+# Copyright (C) 2018 - 2020 Greenbone Networks GmbH
 #
 # SPDX-License-Identifier: GPL-3.0-or-later
 #
@@ -21,25 +21,3 @@
 
 def deprecation(message: str):
     warnings.warn(message, DeprecationWarning, stacklevel=2)
-
-
-def get_version_string(version: tuple) -> str:
-    """Create a version string from a version tuple
-
-    Arguments:
-        version: version as tuple e.g. (1, 2, 0, dev, 5)
-
-    Returns:
-        The version tuple converted into a string representation
-    """
-    if len(version) > 4:
-        ver = ".".join(str(x) for x in version[:4])
-        ver += str(version[4])
-
-        if len(version) > 5:
-            # support (1, 2, 3, 'beta', 2, 'dev', 1)
-            ver += ".{0}{1}".format(str(version[5]), str(version[6]))
-
-        return ver
-    else:
-        return ".".join(str(x) for x in version)