From ad409a5c35cfcf610286f0fed204a4742de00e79 Mon Sep 17 00:00:00 2001 From: Steven Elliott Date: Wed, 20 Nov 2024 08:06:26 -0500 Subject: [PATCH 1/4] Using built-in tools to automatically version FIREWHEEL --- pyproject.toml | 3 --- src/firewheel/__init__.py | 2 -- src/firewheel/cli/firewheel_cli.py | 3 ++- src/firewheel/lib/grpc/firewheel_grpc_server.py | 3 ++- src/firewheel/tests/unit/cli/test_cli.py | 3 ++- 5 files changed, 6 insertions(+), 8 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index b35aed73..f85a6eba 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -116,9 +116,6 @@ get_fw_tab_completion_script = "firewheel.cli.completion.prepare_completion_scri # Required for tox documentation building firewheel = ["firewheel.yaml"] -[tool.setuptools.dynamic] -version = {attr = "firewheel.__version__"} - [tool.setuptools_scm] [tool.doc8] diff --git a/src/firewheel/__init__.py b/src/firewheel/__init__.py index 4c907d6a..dd74869d 100644 --- a/src/firewheel/__init__.py +++ b/src/firewheel/__init__.py @@ -1,5 +1,3 @@ from pathlib import Path -__version__ = "2.7.0" - FIREWHEEL_PACKAGE_DIR = Path(__file__).parent diff --git a/src/firewheel/cli/firewheel_cli.py b/src/firewheel/cli/firewheel_cli.py index aa43623f..c0aa5103 100755 --- a/src/firewheel/cli/firewheel_cli.py +++ b/src/firewheel/cli/firewheel_cli.py @@ -7,6 +7,7 @@ import textwrap from math import floor from uuid import uuid4 +from importlib.metadata import version from rich.columns import Columns from rich.console import Console @@ -953,7 +954,7 @@ def do_version(self, arg): # Write to the history file. if not self.interactive: self.write_history(f"version {arg}") - print(firewheel.__version__) + print(version("firewheel")) def help_list(self): """Help message for the list command. diff --git a/src/firewheel/lib/grpc/firewheel_grpc_server.py b/src/firewheel/lib/grpc/firewheel_grpc_server.py index cec9e89f..3f046d95 100644 --- a/src/firewheel/lib/grpc/firewheel_grpc_server.py +++ b/src/firewheel/lib/grpc/firewheel_grpc_server.py @@ -6,6 +6,7 @@ from typing import Iterable from datetime import datetime from concurrent import futures +from importlib.metadata import version import grpc from google.protobuf.json_format import Parse, MessageToDict @@ -52,7 +53,7 @@ def __init__(self): self.log.info("Initialized FirewheelServicer log.") self.server_start_time = datetime.utcnow() - self.version = firewheel.__version__ + self.version = version("firewheel") self.cache_dir = os.path.join( config["grpc"]["root_dir"], config["grpc"]["cache_dir"] ) diff --git a/src/firewheel/tests/unit/cli/test_cli.py b/src/firewheel/tests/unit/cli/test_cli.py index ac83c167..4de8f8e3 100644 --- a/src/firewheel/tests/unit/cli/test_cli.py +++ b/src/firewheel/tests/unit/cli/test_cli.py @@ -5,6 +5,7 @@ import tempfile import unittest import unittest.mock +from importlib.metadata import version import firewheel from firewheel.config import Config @@ -277,7 +278,7 @@ def test_do_version(self, mock_stdout): args = "" cli.do_version(args) - self.assertEqual(mock_stdout.getvalue().strip(), firewheel.__version__) + self.assertEqual(mock_stdout.getvalue().strip(), version("firewheel")) def test_do_exit(self): cli = FirewheelCLI() From 8586e7164ed442e56a2a67615de6eaf6410a0926 Mon Sep 17 00:00:00 2001 From: Steven Elliott Date: Wed, 20 Nov 2024 08:14:30 -0500 Subject: [PATCH 2/4] Removing unused imports --- src/firewheel/cli/firewheel_cli.py | 1 - src/firewheel/lib/grpc/firewheel_grpc_server.py | 1 - 2 files changed, 2 deletions(-) diff --git a/src/firewheel/cli/firewheel_cli.py b/src/firewheel/cli/firewheel_cli.py index c0aa5103..498724bb 100755 --- a/src/firewheel/cli/firewheel_cli.py +++ b/src/firewheel/cli/firewheel_cli.py @@ -13,7 +13,6 @@ from rich.console import Console from rich.markdown import Markdown -import firewheel from firewheel.cli import utils from firewheel.config import Config from firewheel.lib.log import Log diff --git a/src/firewheel/lib/grpc/firewheel_grpc_server.py b/src/firewheel/lib/grpc/firewheel_grpc_server.py index 3f046d95..eb3529b4 100644 --- a/src/firewheel/lib/grpc/firewheel_grpc_server.py +++ b/src/firewheel/lib/grpc/firewheel_grpc_server.py @@ -11,7 +11,6 @@ import grpc from google.protobuf.json_format import Parse, MessageToDict -import firewheel from firewheel.config import Config from firewheel.lib.log import Log from firewheel.lib.grpc import firewheel_grpc_pb2, firewheel_grpc_pb2_grpc From a93004b1ff9bb301ecbb5238345d6b2551d81bef Mon Sep 17 00:00:00 2001 From: Steven Elliott Date: Wed, 20 Nov 2024 08:29:41 -0500 Subject: [PATCH 3/4] Adding CHANGELOG entries --- CHANGELOG.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index a2b7ec24..f1370980 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,6 +11,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Added ### Changed +* Using built-in tools to automatically version FIREWHEEL. +* Adding the horizontal logo for FIREWHEEL to the README. +* Fixing the license appearance on PyPI. +* Fixing a few references to GitLab that should be GitHub. ### Deprecated From 23f5b66f68fd75bd4828630ad6adbd6d5a7e7142 Mon Sep 17 00:00:00 2001 From: Steven Elliott Date: Wed, 20 Nov 2024 10:23:27 -0500 Subject: [PATCH 4/4] Fixing linting and reverting changelog entries. --- CHANGELOG.md | 4 ---- src/firewheel/tests/unit/cli/test_cli.py | 1 - 2 files changed, 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f1370980..a2b7ec24 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,10 +11,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Added ### Changed -* Using built-in tools to automatically version FIREWHEEL. -* Adding the horizontal logo for FIREWHEEL to the README. -* Fixing the license appearance on PyPI. -* Fixing a few references to GitLab that should be GitHub. ### Deprecated diff --git a/src/firewheel/tests/unit/cli/test_cli.py b/src/firewheel/tests/unit/cli/test_cli.py index 4de8f8e3..d5be4d47 100644 --- a/src/firewheel/tests/unit/cli/test_cli.py +++ b/src/firewheel/tests/unit/cli/test_cli.py @@ -7,7 +7,6 @@ import unittest.mock from importlib.metadata import version -import firewheel from firewheel.config import Config from firewheel.cli.utils import HelperNotFoundError from firewheel.cli.firewheel_cli import FirewheelCLI