Clean up code structure located under python_gardenlinux_lib

Signed-off-by: Tobias Wolf <[email protected]>

Author: NotTheEvilOne

README.md

@@ -20,7 +20,7 @@ Features:
 
 **Inclusion via poetry**:
 
-`gardenlinux = { git  = "https://github.com/gardenlinux/python_gardenlinux_lib", rev="0.6.0" }`
+`gardenlinux = { git  = "https://github.com/gardenlinux/python_gardenlinux_lib", rev="0.7.0" }`
 
 ```python
 from gardenlinux.features import Parser

docs/conf.py

@@ -2,7 +2,6 @@
 import sys
 
 sys.path.insert(0, os.path.abspath("../src"))
-import python_gardenlinux_lib
 
 
 # Configuration file for the Sphinx documentation builder.

docs/index.rst

@@ -4,13 +4,19 @@
    contain the root `toctree` directive.
 
 python-gardenlinux-lib documentation
-================================
-.. automodule:: python_gardenlinux_lib.parse_features
+====================================
+.. automodule:: gardenlinux.apt
     :members:
-.. automodule:: python_gardenlinux_lib.package_repo_info
+.. automodule:: gardenlinux.features
+    :members:
+.. automodule:: gardenlinux.flavors
+    :members:
+.. automodule:: gardenlinux.git
+    :members:
+.. automodule:: gardenlinux.oci
     :members:
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 3
    :caption: Contents:
 
 Indices and tables

pyproject.toml

@@ -5,7 +5,7 @@ description = "Contains tools to work with the features directory of gardenlinux
 authors = ["Garden Linux Maintainers <[email protected]>"]
 license = "Apache-2.0"
 readme = "README.md"
-packages = [{include = "gardenlinux", from="src"}, {include = "python_gardenlinux_lib", from="src"}]
+packages = [{include = "gardenlinux", from="src"}]
 
 [tool.poetry.dependencies]
 python = "^3.13"

src/gardenlinux/flavors/__main__.py

@@ -2,11 +2,12 @@
 # -*- coding: utf-8 -*-
 
 from argparse import ArgumentParser
-from git import Git
 import json
 import os
 import sys
 
+from ..git import Git
+
 from .parser import Parser
 
 
@@ -93,7 +94,7 @@ def parse_args():
 def main():
     args = parse_args()
 
-    repo_path = Git(".").rev_parse("--show-superproject-working-tree")
+    repo_path = Git().root
     flavors_file = os.path.join(repo_path, "flavors.yaml")
 
     if not os.path.isfile(flavors_file):

src/gardenlinux/git/git.py

@@ -1,16 +1,18 @@
 # -*- coding: utf-8 -*-
 
+import sys
+from git import Repo
 from git import Git as _Git
+from os import PathLike
 from pathlib import Path
-import sys
 
 from ..logger import LoggerSetup
 
 
-class Git:
+class Git(object):
     """Git operations handler."""
 
-    def __init__(self, logger=None):
+    def __init__(self, git_directory=".", logger=None):
         """Initialize Git handler.
 
         Args:
@@ -20,11 +22,29 @@ def __init__(self, logger=None):
         if logger is None or not logger.hasHandlers():
             logger = LoggerSetup.get_logger("gardenlinux.git")
 
+        if not isinstance(git_directory, PathLike):
+            git_directory = Path(git_directory)
+
+        if not git_directory.is_dir():
+            raise RuntimeError(f"Git directory given is invalid: {git_directory}")
+
+        self._git_directory = git_directory
         self._logger = logger
 
-    def get_root(self):
+    @property
+    def commit_id(self):
+        """Get the commit ID for Git `HEAD`."""
+        return str(self.root_repo.head.commit)
+
+    @property
+    def root(self):
         """Get the root directory of the current Git repository."""
-        root_dir = Git(".").rev_parse("--show-superproject-working-tree")
-        self.log.debug(f"Git root directory: {root_dir}")
+        root_dir = _Git(self._git_directory).rev_parse("--show-superproject-working-tree")
+        self._logger.debug(f"Git root directory: {root_dir}")
 
         return Path(root_dir)
+
+    @property
+    def root_repo(self):
+        """Get the root Git `Repo` instance."""
+        return Repo(self.root)