tgedr-pycommons 0.0.2__tar.gz

tgedr_pycommons-0.0.2/PKG-INFO

@@ -0,0 +1,27 @@
+Metadata-Version: 2.4
+Name: tgedr-pycommons
+Version: 0.0.2
+Summary: common python code usable across projects
+Author-email: joao tiago viegas <3536754+jtviegas@users.noreply.github.com>
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: pandas>=2.3.0
+
+# tgedr-pycommons
+
+![Coverage](./coverage.svg)
+
+Common code to be used across projects
+
+
+## development
+- main requirements:
+  - _uv_  
+  - _bash_
+- Clone the repository like this:
+
+  ``` bash
+  git clone git@github.com:tgedr/pycommons
+  ```
+- cd into the folder: `cd pycommons`
+- install requirements: `./helper.sh reqs`

tgedr_pycommons-0.0.2/README.md

@@ -0,0 +1,18 @@
+# tgedr-pycommons
+
+![Coverage](./coverage.svg)
+
+Common code to be used across projects
+
+
+## development
+- main requirements:
+  - _uv_  
+  - _bash_
+- Clone the repository like this:
+
+  ``` bash
+  git clone git@github.com:tgedr/pycommons
+  ```
+- cd into the folder: `cd pycommons`
+- install requirements: `./helper.sh reqs`

tgedr_pycommons-0.0.2/pyproject.toml

@@ -0,0 +1,131 @@
+[project]
+name = "tgedr-pycommons"
+version = "0.0.2"
+description = "common python code usable across projects"
+authors = [
+    {name = "joao tiago viegas",email = "3536754+jtviegas@users.noreply.github.com"}
+]
+readme = "README.md"
+requires-python = ">=3.11"
+
+dependencies = [
+    "pandas>=2.3.0",
+]
+
+[dependency-groups]
+dev = [
+    "pre-commit~=4.2.0",
+    "pytest~=8.3.5",
+    "pytest-bdd~=8.1.0",
+    "pytest-cov~=4.1.0",
+    "pytest-mock~=3.15.0",
+    "ruff==0.9.10",
+    "bandit==1.8.3",
+    "safety==3.5.1",
+    "typer<0.17.0",
+    "genbadge[coverage]>=1.1.3",
+]
+
+
+# [project.scripts]
+# run = "ssds_pycommons.pip_entrypoint:entrypoint" 
+
+[build-system]
+requires = ["setuptools>=78.1.0", "wheel>=0.45.1"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.package-data]
+"*" = ["CHANGELOG"]
+
+[tool.coverage.paths]
+source = ["src/"]
+
+[tool.coverage.run]
+source = ["src/"]
+include = ["src/*"]
+omit = [
+    "*/tests/*",
+    "*/test_*",
+    "*/__pycache__/*",
+    "*/migrations/*",
+    "*/venv/*",
+    "*/.venv/*"
+]
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "def __repr__",
+    "raise AssertionError",
+    "raise NotImplementedError",
+    "if __name__ == .__main__.:",
+    "if TYPE_CHECKING:",
+]
+show_missing = true
+skip_covered = false
+skip_empty = false
+
+[tool.pytest.ini_options]
+# bdd_features_base_dir = "documentation/features"
+pythonpath = "."
+
+[tool.ruff]
+exclude = [
+    ".bzr",
+    ".direnv",
+    ".eggs",
+    ".git",
+    ".git-rewrite",
+    ".hg",
+    ".ipynb_checkpoints",
+    ".mypy_cache",
+    ".nox",
+    ".pants.d",
+    ".pyenv",
+    ".pytest_cache",
+    ".pytype",
+    ".ruff_cache",
+    ".svn",
+    ".tox",
+    ".venv",
+    ".vscode",
+    "__pypackages__",
+    "_build",
+    "buck-out",
+    "build",
+    "dist",
+    "node_modules",
+    "site-packages",
+    "venv",
+    "tests/",
+    "typings/"
+]
+
+line-length = 120
+indent-width = 4
+
+[tool.ruff.lint]
+select = ["ALL"]
+ignore = ["D203", "S101", "D104", "INP001", "D213", "COM812", "I001", 
+    "D401", "D407", "RET504", "PLR2004", "FA102", "E501", "EXE002", "PLR0913", 
+    "PLR0912", "C901", "PLR0911", "ANN401"]
+fixable = ["ALL"]
+unfixable = []
+# Allow unused variables when underscore-prefixed.
+dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+
+[tool.ruff.format]
+# Like Black, use double quotes for strings.
+quote-style = "double"
+# Like Black, indent with spaces, rather than tabs.
+indent-style = "space"
+# Like Black, respect magic trailing commas.
+skip-magic-trailing-comma = false
+# Like Black, automatically detect the appropriate line ending.
+line-ending = "auto"

tgedr_pycommons-0.0.2/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

tgedr_pycommons-0.0.2/src/tgedr/pycommons/entrypoint.py

@@ -0,0 +1,100 @@
+"""Module for executing Python callables based on command line arguments.
+
+This module provides utilities to:
+- Parse command line arguments for callable execution
+- Resolve callables (functions or class methods) from module paths
+- Execute the resolved callable with provided parameters
+"""
+
+import argparse
+from collections.abc import Sequence
+from argparse import Namespace
+import json
+import logging
+from importlib import import_module
+from typing import Any
+
+
+root_logger = logging.getLogger()
+root_logger.setLevel(logging.INFO)
+stream_handler = logging.StreamHandler()
+stream_handler.setLevel(logging.INFO)
+formatter = logging.Formatter("[%(asctime)s] [%(name)s] [%(levelname)s] => %(message)s")
+stream_handler.setFormatter(formatter)
+root_logger.addHandler(stream_handler)
+
+logger = logging.getLogger(__name__)
+
+
+def parse_arguments(explicit_args: Sequence[str] | None = None) -> Namespace:
+    """Parse command line arguments for the python callable execution.
+
+    Args:
+      explicit_args: A sequence of command line arguments
+    Returns:
+      Namespace: The parsed command line arguments
+
+    """
+    parser = argparse.ArgumentParser(description="Get the parameters for the python callable to execute.")
+    parser.add_argument("--module", type=str, help="The module where to find the callable")
+    parser.add_argument("--callable", type=str, help="The callable (function or class function)")
+    parser.add_argument(
+        "--classname", required=False, type=str, help="If the callable is a class function, specify the class name"
+    )
+    parser.add_argument(
+        "--classparams",
+        required=False,
+        type=str,
+        help="If the callable is a class function, specify the class constructor parameters (as a JSON string)",
+    )
+    parser.add_argument("--params", type=str, help="The parameters for the callable (as a JSON string)")
+    args = parser.parse_args(explicit_args)
+    return args
+
+
+def resolve_callable(arguments: Namespace) -> Any:
+    """Resolve the callable from the parsed arguments.
+
+    Args:
+      arguments (Namespace): The parsed command line arguments
+    Returns:
+      Any: The resolved callable (function or class method)
+
+    """
+    result = None
+
+    if arguments.classname:
+        _class = getattr(import_module(arguments.module), arguments.classname)
+        class_instance = None
+        if arguments.classparams:
+            class_params: dict = json.loads(arguments.classparams)
+            class_instance = _class(**class_params)
+        else:
+            class_instance = _class()
+        result = getattr(class_instance, arguments.callable)
+    else:
+        result = getattr(import_module(arguments.module), arguments.callable)
+
+    return result
+
+
+def entrypoint(explicit_args: Sequence[str] | None = None) -> Any:
+    """Execute a python callable based on command line arguments.
+
+    Args:
+      explicit_args: A sequence of command line arguments
+    Returns:
+      Any: The result of the executed callable
+
+    """
+    args: Namespace = parse_arguments(explicit_args)
+    call = resolve_callable(args)
+    if args.params:
+        params: dict = json.loads(args.params)
+        result: Any = call(**params)
+    else:
+        result: Any = call()
+    # Print result to stdout for shell capture
+    if result is not None:
+        print(result)  # noqa: T201
+    return result

tgedr_pycommons-0.0.2/src/tgedr_pycommons.egg-info/PKG-INFO

@@ -0,0 +1,27 @@
+Metadata-Version: 2.4
+Name: tgedr-pycommons
+Version: 0.0.2
+Summary: common python code usable across projects
+Author-email: joao tiago viegas <3536754+jtviegas@users.noreply.github.com>
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: pandas>=2.3.0
+
+# tgedr-pycommons
+
+![Coverage](./coverage.svg)
+
+Common code to be used across projects
+
+
+## development
+- main requirements:
+  - _uv_  
+  - _bash_
+- Clone the repository like this:
+
+  ``` bash
+  git clone git@github.com:tgedr/pycommons
+  ```
+- cd into the folder: `cd pycommons`
+- install requirements: `./helper.sh reqs`

tgedr_pycommons-0.0.2/src/tgedr_pycommons.egg-info/SOURCES.txt

@@ -0,0 +1,9 @@
+README.md
+pyproject.toml
+src/tgedr/__init__.py
+src/tgedr/pycommons/entrypoint.py
+src/tgedr_pycommons.egg-info/PKG-INFO
+src/tgedr_pycommons.egg-info/SOURCES.txt
+src/tgedr_pycommons.egg-info/dependency_links.txt
+src/tgedr_pycommons.egg-info/requires.txt
+src/tgedr_pycommons.egg-info/top_level.txt

tgedr_pycommons-0.0.2/src/tgedr_pycommons.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

tgedr_pycommons-0.0.2/src/tgedr_pycommons.egg-info/requires.txt

@@ -0,0 +1 @@
+pandas>=2.3.0

tgedr_pycommons-0.0.2/src/tgedr_pycommons.egg-info/top_level.txt

@@ -0,0 +1 @@
+tgedr