Restructure gardenlinux to clean up code and logic

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,21 @@
    contain the root `toctree` directive.
 
 python-gardenlinux-lib documentation
-================================
-.. automodule:: python_gardenlinux_lib.parse_features
+====================================
+.. automodule:: gardenlinux
     :members:
-.. automodule:: python_gardenlinux_lib.package_repo_info
+.. automodule:: gardenlinux.apt
+    :members:
+.. 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

@@ -1,11 +1,11 @@
 [tool.poetry]
 name = "gardenlinux"
-version = "0.6.0"
+version = "0.7.0"
 description = "Contains tools to work with the features directory of gardenlinux, for example deducting dependencies from feature sets or validating cnames"
 authors = ["Garden Linux Maintainers <contact@gardenlinux.io>"]
 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"
@@ -15,18 +15,16 @@ pytest = "^8.3.2"
 gitpython = "^3.1.44"
 apt-repo = "^0.5"
 jsonschema = "^4.23.0"
-oras = { git  = "https://github.com/oras-project/oras-py.git", rev="caf8db5b279382335fbb1f6d7402ed9b73618d37" }
+oras = "^0.2.33"
 python-dotenv = "^1.0.1"
 cryptography = "^44.0.0"
 boto3 = "*"
 click = "^8.2.0"
 pygments = "^2.19.1"
-opencontainers = "^0.0.14"
 
 [tool.poetry.group.dev.dependencies]
 bandit = "^1.8.3"
 black = "^24.8.0"
-opencontainers = "^0.0.14"
 
 [tool.poetry.group.docs.dependencies]
 sphinx-rtd-theme = "^2.0.0"
@@ -36,7 +34,6 @@ gl-cname = "gardenlinux.features.cname_main:main"
 gl-features-parse = "gardenlinux.features.__main__:main"
 gl-flavors-parse = "gardenlinux.flavors.__main__:main"
 gl-oci = "gardenlinux.oci.__main__:main"
-flavors-parse = "gardenlinux.flavors.__main__:main"
 
 [tool.pytest.ini_options]
 pythonpath = ["src"]

src/gardenlinux/apt/__init__.py

@@ -1,5 +1,9 @@
 # -*- coding: utf-8 -*-
 
+"""
+APT module
+"""
+
 from .debsource import Debsrc, DebsrcFile
 
-__all__ = ["Parser"]
+__all__ = ["Debsrc", "DebsrcFile"]

src/gardenlinux/apt/debsource.py

@@ -1,27 +1,63 @@
 # -*- coding: utf-8 -*-
-# SPDX-License-Identifier: MIT
 
-# Based on code from glvd https://github.com/gardenlinux/glvd/blob/7ca2ff54e01da5e9eae61d1cd565eaf75f3c62ce/src/glvd/data/debsrc.py#L1
-
-from __future__ import annotations
+"""
+deb sources
+"""
 
 import re
 from typing import TextIO
 
 
 class Debsrc:
+    """
+    Class to reflect deb sources.
+
+    :author:     Garden Linux Maintainers
+    :copyright:  Copyright 2024 SAP SE
+    :package:    gardenlinux
+    :subpackage: apt
+    :since:      0.7.0
+    :license:    https://www.apache.org/licenses/LICENSE-2.0
+                 Apache License, Version 2.0
+    """
+
     def __init__(self, deb_source, deb_version):
-        self.deb_source = deb_source
-        self.deb_version = deb_version
+        """
+        Constructor __init__(Debsrc)
+
+        :param deb_source:  Source name
+        :param deb_version: Source version
 
-    deb_source: str
-    deb_version: str
+        :since: 0.7.0
+        """
+
+        self.deb_source: str = deb_source
+        self.deb_version: str = deb_version
 
     def __repr__(self) -> str:
+        """
+        python.org: Called by the repr() built-in function to compute the "official" string representation of an object.
+
+        :return: (str) String representation
+        :since:  0.7.0
+        """
+
         return f"{self.deb_source} {self.deb_version}"
 
 
 class DebsrcFile(dict[str, Debsrc]):
+    """
+    Class to represent deb sources loaded and parsed as dict.
+
+    :author:     Garden Linux Maintainers
+    :copyright:  Copyright 2024 SAP SE
+    :package:    gardenlinux
+    :subpackage: apt
+    :since:      0.7.0
+    :license:    https://www.apache.org/licenses/LICENSE-2.0
+                 Apache License, Version 2.0
+    """
+
     __re = re.compile(
         r"""
         ^(?:
@@ -43,31 +79,42 @@ class DebsrcFile(dict[str, Debsrc]):
         re.VERBOSE,
     )
 
-    def _read_source(self, source: str, version: str) -> None:
-        self[source] = Debsrc(
-            deb_source=source,
-            deb_version=version,
-        )
-
     def read(self, f: TextIO) -> None:
-        current_source = current_version = None
+        """
+        Read and parse the given TextIO data to extract deb sources.
+
+        :param f: TextIO data to parse
+
+        :since: 0.7.0
+        """
 
-        def finish():
-            if current_source and current_version:
-                self._read_source(current_source, current_version)
+        parsed_source = parsed_version = None
 
         for line in f.readlines():
             if match := self.__re.match(line):
                 if i := match["source"]:
-                    current_source = i
+                    parsed_source = i
                 elif i := match["version"]:
-                    current_version = i
+                    parsed_version = i
                 elif match["eso"]:
-                    current_source = current_version = None
+                    parsed_source = parsed_version = None
                 elif match["eoe"] is not None:
-                    finish()
-                    current_source = current_version = None
+                    self._set_source(parsed_source, parsed_version)
+                    parsed_source = parsed_version = None
             else:
                 raise RuntimeError(f"Unable to read line: {line}")
 
-        finish()
+        self._set_source(parsed_source, parsed_version)
+
+    def _set_source(self, source: str, version: str) -> None:
+        """
+        Sets the dict value based on the given source key.
+
+        :since: 0.7.0
+        """
+
+        if source and version:
+            self[source] = Debsrc(
+                deb_source=source,
+                deb_version=version,
+            )