rkt-tool-lib 1.4.1__tar.gz → 2.0.0__tar.gz

rkt_tool_lib-2.0.0/PKG-INFO

@@ -0,0 +1,9 @@
+Metadata-Version: 2.4
+Name: rkt_tool_lib
+Version: 2.0.0
+Summary: RootKit custom tool Lib
+Author-email: RootKit <rootkit@rootkit-lab.org>
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7

rkt_tool_lib-2.0.0/README.md

@@ -0,0 +1,22 @@
+# rkt_tool_lib
+
+Cross-platform file system utilities.
+
+## Features
+- **Path Normalization**: Automatically formats paths (`/` vs `\`) based on the operating system (Windows/Linux).
+- **Recursive Search**: Utilities to find directories deeply nested in the file system.
+- **Singleton Pattern**: (Optional usage via `Singleton` metaclass provided).
+
+## Usage
+
+```python
+from tool import Tool
+
+t = Tool()
+
+# Get current working directory formatted for OS
+cwd = t.get_cwd()
+
+# Find a directory named 'logs' recursively
+log_path = t.get_dir("logs")
+```

rkt_tool_lib-2.0.0/pyproject.toml

@@ -0,0 +1,21 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "rkt_tool_lib"
+version = "2.0.0"
+description = "RootKit custom tool Lib"
+authors = [
+  { name="RootKit", email="rootkit@rootkit-lab.org" },
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+requires-python = ">=3.7"
+dependencies = []
+
+[tool.setuptools.packages.find]
+where = ["src"]

rkt_tool_lib-2.0.0/src/rkt_tool_lib.egg-info/PKG-INFO

@@ -0,0 +1,9 @@
+Metadata-Version: 2.4
+Name: rkt_tool_lib
+Version: 2.0.0
+Summary: RootKit custom tool Lib
+Author-email: RootKit <rootkit@rootkit-lab.org>
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7

rkt_tool_lib-2.0.0/src/rkt_tool_lib.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+README.md
+pyproject.toml
+src/rkt_tool_lib.egg-info/PKG-INFO
+src/rkt_tool_lib.egg-info/SOURCES.txt
+src/rkt_tool_lib.egg-info/dependency_links.txt
+src/rkt_tool_lib.egg-info/top_level.txt
+src/tool/__init__.py
+src/tool/py.typed
+src/tool/tool.py
+tests/test_tool.py

rkt_tool_lib-2.0.0/src/tool/__init__.py

@@ -0,0 +1 @@
+from .tool import Singleton, Tool

rkt_tool_lib-2.0.0/src/tool/tool.py

@@ -0,0 +1,84 @@
+import os
+from typing import Any, Optional
+
+
+class Singleton(type):
+    """
+    The Singleton class can be implemented in different ways in Python. Some
+    possible methods include: base class, decorator, metaclass. We will use the
+    metaclass because it is best suited for this purpose.
+    """
+
+    _instances: dict[type, object] = {}
+
+    def __call__(cls, *args: Any, **kwargs: Any) -> Any:
+        """
+        Possible changes to the value of the `__init__` argument do not affect
+        the returned instance.
+        """
+        if cls not in cls._instances:
+            instance = super().__call__(*args, **kwargs)
+            cls._instances[cls] = instance
+        return cls._instances[cls]
+
+
+class Tool:
+    """
+    Utility class for file system operations.
+
+    Provides cross-platform methods for path formatting and recursive directory searching.
+    """
+
+    @staticmethod
+    def formatted_from_os(path: str) -> str:
+        """
+        Format a path string to match the current operating system's separator.
+
+        Args:
+            path (str): The path to format.
+
+        Returns:
+            str: The formatted path with correct separators and trailing separator handled.
+        """
+        if os.name == "nt":
+            sep = "\\"
+            res = f"{path.replace('/', sep)}{sep if path[-1] != sep else ''}"
+        else:
+            res = f"{path}{'/' if path[-1] != '/' else ''}"
+
+        return res
+
+    def get_cwd(self) -> str:
+        """
+        Get the current working directory, formatted for the OS.
+
+        Returns:
+            str: Absolute path of the CWD.
+        """
+        return self.formatted_from_os(os.getcwd())
+
+    def get_dir(self, folder: str, root: Optional[str] = None) -> Optional[str]:
+        """
+        Recursively search for a directory by name.
+
+        Args:
+            folder (str): The name of the directory to find.
+            root (Optional[str], optional): The root directory to start searching from.
+                                            If None, uses current working directory. Defaults to None.
+
+        Returns:
+            Optional[str]: Absolute path to the found directory, or None if not found.
+        """
+        root = self.get_cwd() if not root else self.formatted_from_os(root)
+
+        for element in os.listdir(root):
+            if os.path.isdir(f"{root}{element}") and element == folder:
+                return self.formatted_from_os(f"{root}{element}")
+
+        for element in os.listdir(root):
+            if os.path.isdir(f"{root}{element}"):
+                found = self.get_dir(folder, self.formatted_from_os(f"{root}{element}"))
+                if found:
+                    return found
+
+        return None

rkt_tool_lib-2.0.0/tests/test_tool.py

@@ -0,0 +1,86 @@
+import os
+from unittest.mock import patch
+
+from tool import Singleton, Tool
+
+obj = Tool()
+
+
+class FakeClass(metaclass=Singleton):  # type: ignore[metaclass]
+    def __init__(self) -> None:
+        self.name = "singleton"
+
+
+class TestTool:
+    def test_formatted_from_os(self) -> None:
+        if os.name == "nt":
+            excepted = obj.formatted_from_os(os.getcwd()).endswith("\\")
+        else:
+            excepted = obj.formatted_from_os(os.getcwd()).endswith("/")
+        assert excepted
+
+    def test_get_cwd(self) -> None:
+        assert obj.get_cwd() == f"{os.getcwd()}\\" if os.name == "nt" else f"{os.getcwd()}/"
+
+    def test_get_dir_flat(self) -> None:
+        with patch("os.getcwd", return_value="C:\\fake\\root" if os.name == "nt" else "/fake/root"):
+            with patch("os.listdir", return_value=["target"]):
+                with patch("os.path.isdir", return_value=True):
+                    # Mock Tool.formatted_from_os to behave simply (it uses os.name, assume consistent)
+                    # Actually Tool uses os.name real value.
+                    # If we mock os.getcwd, Tool.get_cwd() calls real Tool.formatted_from_os which uses real path sep.
+                    # So we should match the format.
+
+                    root_sep = "\\" if os.name == "nt" else "/"
+                    root = f"C:{root_sep}fake{root_sep}root" if os.name == "nt" else "/fake/root"
+
+                    # We need to simulate get_dir logic:
+                    # listdir(root) -> ['target']
+                    # isdir(root/target) -> True
+                    # element == folder
+
+                    # We search for "target"
+                    expected = f"{root}{root_sep}target{root_sep}"
+
+                    # We can just test that logic finds it
+                    # But Tool.get_dir uses os.listdir which we patched.
+
+                    res = obj.get_dir("target")
+                    assert res == expected
+
+    def test_get_dir_recursive(self) -> None:
+        # Setup: root -> [folder1] -> [target]
+        root_sep = "\\" if os.name == "nt" else "/"
+        root = f"C:{root_sep}fake{root_sep}root" if os.name == "nt" else "/fake/root"
+
+        def listdir_side_effect(path: str) -> list[str]:
+            # Normalize path for comparison if needed, but let's assume strict basic paths
+            # formatted_from_os ensures trailing slash
+            # Tool logic: listdir(root).
+            if path.startswith(root) and "folder1" not in path:
+                return ["folder1"]
+            if "folder1" in path:
+                return ["target"]
+            return []
+
+        def isdir_side_effect(path: str) -> bool:
+            return True
+
+        with patch("os.getcwd", return_value=root.rstrip(root_sep)):  # get_cwd calls formatted_from_os which adds slash
+            with patch("os.listdir", side_effect=listdir_side_effect):
+                with patch("os.path.isdir", return_value=True):
+                    expected = f"{root}{root_sep}folder1{root_sep}target{root_sep}"
+                    res = obj.get_dir("target")
+                    # Depending on implementation it might find it.
+                    # Recursion:
+                    # 1. root listdir -> folder1. folder1 != target.
+                    # 2. recursive call on root/folder1.
+                    # 3. root/folder1 listdir -> target. target == target. Return.
+                    assert res == expected
+
+
+class TestSingleton:
+    def test_singleton(self) -> None:
+        obj_1 = FakeClass()
+        obj_2 = FakeClass()
+        assert obj_1 == obj_2

rkt_tool_lib-1.4.1/LICENSE

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2016 Dabo Ross
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

rkt_tool_lib-1.4.1/PKG-INFO

@@ -1,81 +0,0 @@
-Metadata-Version: 2.1
-Name: rkt_tool_lib
-Version: 1.4.1
-Summary: RootKit custom tool Lib
-Author: RootKit
-Author-email: rootkit@rootkit-lab.org
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Intended Audience :: Developers
-Classifier: Intended Audience :: End Users/Desktop
-Classifier: Intended Audience :: Information Technology
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Natural Language :: English
-Classifier: Natural Language :: French
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Topic :: Utilities
-Requires-Python: >=3.7
-Description-Content-Type: text/markdown
-License-File: LICENSE
-
-# rkt_tool_lib - Python library
-
-![Package Version](https://badgen.net/badge/Package%20Version/latest%20-%201.3.0/green?scale=1.2)
-
-![quality](https://sonarqube.tprc.ovh/api/project_badges/measure?project=python_rkt_lib_toolkit_AXqQ32evGCA0VuRY8SuD&metric=alert_status)
-![reliability_rating](https://sonarqube.tprc.ovh/api/project_badges/measure?project=python_rkt_lib_toolkit_AXqQ32evGCA0VuRY8SuD&metric=reliability_rating)
-![security_rating](https://sonarqube.tprc.ovh/api/project_badges/measure?project=python_rkt_lib_toolkit_AXqQ32evGCA0VuRY8SuD&metric=security_rating)
-![vulnerabilities](https://sonarqube.tprc.ovh/api/project_badges/measure?project=python_rkt_lib_toolkit_AXqQ32evGCA0VuRY8SuD&metric=vulnerabilities)
-![coverage](https://sonarqube.tprc.ovh/api/project_badges/measure?project=python_rkt_lib_toolkit_AXqQ32evGCA0VuRY8SuD&metric=coverage)
-![maintainability](https://sonarqube.tprc.ovh/api/project_badges/measure?project=python_rkt_lib_toolkit_AXqQ32evGCA0VuRY8SuD&metric=sqale_rating)
-
-##### Python minimal Version 3.7
-
-----
-
-## What is Python?
-Python is an interpreted high-level general-purpose programming language. Python's design philosophy emphasizes code readability with its notable use of significant indentation. Its language constructs as well as its object-oriented approach aim to help programmers write clear, logical code for small and large-scale projects.
-
-[source](https://en.wikipedia.org/wiki/Python_(programming_language))
-
-## Libraries
-* Tool: toolbox library with, you can automatically format the path in your code without worrying about the platform hosting your script
-
-## Use it
-### Install
-```bash
- (venv) my_project> pip install rkt_tool_lib [--index-url https://gitlab.tprc.ovh/api/v4/groups/python/-/packages/pypi]
-```
-
-### Example
-
-```python
-from rkt_tool_lib import Tool
-
-t = Tool()
-
-print(t.get_cwd())
-print(t.get_dir('db'))
-
-
-```
-
-### Output (as file, sdtout or both)
-windows
-```log
-C:\Users\Me\Documents\path\to\my\project\
-C:\Users\Me\Documents\path\to\my\project\db\
-```
-linux:
-```log
-/home/me/path/to/my/project/
-/home/me/path/to/my/project/db/
-```
-
-## Contributing
-
-If you find this library useful here's how you can help:
-
-- Send a merge request with your kickass new features and bug fixes
-- Help new users with [issues](https://gitlab.tprc.ovh/python/rkt_lib_toolkit/-/issues) they may encounter
-- Support the development of this library and star this repo!

rkt_tool_lib-1.4.1/rkt_lib_toolkit/rkt_tool_lib.egg-info/PKG-INFO

@@ -1,81 +0,0 @@
-Metadata-Version: 2.1
-Name: rkt-tool-lib
-Version: 1.4.1
-Summary: RootKit custom tool Lib
-Author: RootKit
-Author-email: rootkit@rootkit-lab.org
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Intended Audience :: Developers
-Classifier: Intended Audience :: End Users/Desktop
-Classifier: Intended Audience :: Information Technology
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Natural Language :: English
-Classifier: Natural Language :: French
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Topic :: Utilities
-Requires-Python: >=3.7
-Description-Content-Type: text/markdown
-License-File: LICENSE
-
-# rkt_tool_lib - Python library
-
-![Package Version](https://badgen.net/badge/Package%20Version/latest%20-%201.3.0/green?scale=1.2)
-
-![quality](https://sonarqube.tprc.ovh/api/project_badges/measure?project=python_rkt_lib_toolkit_AXqQ32evGCA0VuRY8SuD&metric=alert_status)
-![reliability_rating](https://sonarqube.tprc.ovh/api/project_badges/measure?project=python_rkt_lib_toolkit_AXqQ32evGCA0VuRY8SuD&metric=reliability_rating)
-![security_rating](https://sonarqube.tprc.ovh/api/project_badges/measure?project=python_rkt_lib_toolkit_AXqQ32evGCA0VuRY8SuD&metric=security_rating)
-![vulnerabilities](https://sonarqube.tprc.ovh/api/project_badges/measure?project=python_rkt_lib_toolkit_AXqQ32evGCA0VuRY8SuD&metric=vulnerabilities)
-![coverage](https://sonarqube.tprc.ovh/api/project_badges/measure?project=python_rkt_lib_toolkit_AXqQ32evGCA0VuRY8SuD&metric=coverage)
-![maintainability](https://sonarqube.tprc.ovh/api/project_badges/measure?project=python_rkt_lib_toolkit_AXqQ32evGCA0VuRY8SuD&metric=sqale_rating)
-
-##### Python minimal Version 3.7
-
-----
-
-## What is Python?
-Python is an interpreted high-level general-purpose programming language. Python's design philosophy emphasizes code readability with its notable use of significant indentation. Its language constructs as well as its object-oriented approach aim to help programmers write clear, logical code for small and large-scale projects.
-
-[source](https://en.wikipedia.org/wiki/Python_(programming_language))
-
-## Libraries
-* Tool: toolbox library with, you can automatically format the path in your code without worrying about the platform hosting your script
-
-## Use it
-### Install
-```bash
- (venv) my_project> pip install rkt_tool_lib [--index-url https://gitlab.tprc.ovh/api/v4/groups/python/-/packages/pypi]
-```
-
-### Example
-
-```python
-from rkt_tool_lib import Tool
-
-t = Tool()
-
-print(t.get_cwd())
-print(t.get_dir('db'))
-
-
-```
-
-### Output (as file, sdtout or both)
-windows
-```log
-C:\Users\Me\Documents\path\to\my\project\
-C:\Users\Me\Documents\path\to\my\project\db\
-```
-linux:
-```log
-/home/me/path/to/my/project/
-/home/me/path/to/my/project/db/
-```
-
-## Contributing
-
-If you find this library useful here's how you can help:
-
-- Send a merge request with your kickass new features and bug fixes
-- Help new users with [issues](https://gitlab.tprc.ovh/python/rkt_lib_toolkit/-/issues) they may encounter
-- Support the development of this library and star this repo!

rkt_tool_lib-1.4.1/rkt_lib_toolkit/rkt_tool_lib.egg-info/SOURCES.txt

@@ -1,8 +0,0 @@
-LICENSE
-README
-rkt_lib_toolkit/rkt_tool_lib.egg-info/PKG-INFO
-rkt_lib_toolkit/rkt_tool_lib.egg-info/SOURCES.txt
-rkt_lib_toolkit/rkt_tool_lib.egg-info/dependency_links.txt
-rkt_lib_toolkit/rkt_tool_lib.egg-info/top_level.txt
-rkt_lib_toolkit/tool/Tool.py
-rkt_lib_toolkit/tool/__init__.py

rkt_tool_lib-1.4.1/rkt_lib_toolkit/tool/Tool.py

@@ -1,53 +0,0 @@
-import os
-from typing import Optional
-
-
-class Singleton(type):
-    """
-    The Singleton class can be implemented in different ways in Python. Some
-    possible methods include: base class, decorator, metaclass. We will use the
-    metaclass because it is best suited for this purpose.
-    """
-
-    _instances = {}
-
-    def __call__(cls, *args, **kwargs):
-        """
-        Possible changes to the value of the `__init__` argument do not affect
-        the returned instance.
-        """
-        if cls not in cls._instances:
-            instance = super().__call__(*args, **kwargs)
-            cls._instances[cls] = instance
-        return cls._instances[cls]
-
-
-class Tool:
-
-    @staticmethod
-    def formatted_from_os(path) -> str:
-        if os.name == "nt":
-            sep = "\\"
-            res = f'{path.replace("/", sep)}{sep if path[-1] != sep else ""}'
-        else:
-            res = f'{path}{"/" if path[-1] != "/" else ""}'
-
-        return res
-
-    def get_cwd(self) -> str:
-        return self.formatted_from_os(os.getcwd())
-
-    def get_dir(self, folder, root: Optional[str] = None) -> Optional[str]:
-        root = self.get_cwd() if not root else self.formatted_from_os(root)
-
-        for element in os.listdir(root):
-            if os.path.isdir(f"{root}{element}") and element == folder:
-                return self.formatted_from_os(f"{root}{element}")
-
-        for element in os.listdir(root):
-            if os.path.isdir(f"{root}{element}"):
-                found = self.get_dir(folder, self.formatted_from_os(f"{root}{element}"))
-                if found:
-                    return found
-
-        return None

rkt_tool_lib-1.4.1/rkt_lib_toolkit/tool/__init__.py

@@ -1 +0,0 @@
-from .Tool import Tool, Singleton