linkinpycli 0.0.1__py3-none-any.whl

linkinpycli/crawler.py

@@ -0,0 +1,18 @@
+from importlib.metadata import EntryPoint, entry_points
+
+LINKINPY_SCRIPT_PREFIX = "linkinpy"
+
+
+def find_linkinpy_entry_points() -> list[EntryPoint]:
+    """Find all console-script entry points that start with 'linkinpy'."""
+    return [
+        ep
+        for ep in entry_points(group="console_scripts")
+        if ep.name.startswith(LINKINPY_SCRIPT_PREFIX)
+        and ep.name != "linkinpy-parse"
+    ]
+
+
+def find_linkinpy_scripts() -> list[str]:
+    """Find all console scripts that start with 'linkinpy'."""
+    return [ep.name for ep in find_linkinpy_entry_points()]

linkinpycli/linkinpycli.py

@@ -0,0 +1,117 @@
+from __future__ import annotations
+
+import inspect
+import json
+from importlib import import_module
+from importlib.metadata import EntryPoint
+from pathlib import Path
+
+from .crawler import find_linkinpy_entry_points
+
+
+_IGNORED_SIGNATURE_PARAMETERS = {"argv", "args", "kwargs"}
+
+
+def _format_datatype(annotation: object) -> str:
+    if annotation is inspect.Signature.empty:
+        return "Any"
+    if isinstance(annotation, str):
+        return annotation.replace("pathlib.", "")
+    if getattr(annotation, "__module__", "") == "builtins":
+        return annotation.__name__
+    return str(annotation).replace("pathlib.", "")
+
+
+def _format_default(default: object) -> object:
+    if default is inspect.Signature.empty:
+        return None
+    if isinstance(default, (str, int, float, bool)) or default is None:
+        return default
+    return repr(default)
+
+
+def _signature_arguments(callable_object: object) -> list[dict[str, object]]:
+    signature = inspect.signature(callable_object)
+    arguments = []
+    for name, parameter in signature.parameters.items():
+        if name in _IGNORED_SIGNATURE_PARAMETERS:
+            continue
+        if parameter.kind in (
+            inspect.Parameter.VAR_POSITIONAL,
+            inspect.Parameter.VAR_KEYWORD,
+        ):
+            continue
+        arguments.append(
+            {
+                "name": name,
+                "datatype": _format_datatype(parameter.annotation),
+                "required": parameter.default is inspect.Signature.empty,
+                "default": _format_default(parameter.default),
+            }
+        )
+    return arguments
+
+
+def _entry_point_reference(entry_point: EntryPoint) -> str:
+    return f"{entry_point.module}:{entry_point.attr}"
+
+
+def _resolve_callable(entry_point: EntryPoint) -> object:
+    module = import_module(entry_point.module)
+    entry_callable = entry_point.load()
+    entry_arguments = _signature_arguments(entry_callable)
+    if entry_arguments:
+        return entry_callable
+
+    expected_name = entry_point.name.replace("-", "_")
+    expected_callable = getattr(module, expected_name, None)
+    if callable(expected_callable):
+        return expected_callable
+
+    linkinpy_callables = [
+        obj
+        for name, obj in inspect.getmembers(module, inspect.isfunction)
+        if name.startswith("linkinpy") and name not in {"linkinpy_parse"}
+    ]
+    if len(linkinpy_callables) == 1:
+        return linkinpy_callables[0]
+
+    return entry_callable
+
+
+def _script_details(entry_point: EntryPoint) -> dict[str, object]:
+    details: dict[str, object] = {
+        "name": entry_point.name,
+        "entry_point": _entry_point_reference(entry_point),
+        "arguments": [],
+    }
+    try:
+        callable_object = _resolve_callable(entry_point)
+        details["callable"] = (
+            f"{callable_object.__module__}:{callable_object.__name__}"
+        )
+        details["arguments"] = _signature_arguments(callable_object)
+    except Exception as exc:
+        details["error"] = str(exc)
+    return details
+
+
+def parse_linkinpy_scripts() -> None:
+    """Find LinkinPy console scripts and write their argument metadata to scripts.json."""
+    scripts = [
+        _script_details(entry_point)
+        for entry_point in find_linkinpy_entry_points()
+    ]
+    output_path = Path.cwd() / "scripts.json"
+    output_path.write_text(
+        json.dumps({"scripts": scripts}, indent=2) + "\n",
+        encoding="utf-8",
+    )
+    print(f"Saved {len(scripts)} scripts to {output_path}")
+
+
+class LinkinPyCLI:
+    """Minimal example class generated by the template."""
+
+    def run(self) -> int:
+        return 1

linkinpycli-0.0.1.dist-info/METADATA

@@ -0,0 +1,69 @@
+Metadata-Version: 2.4
+Name: linkinpycli
+Version: 0.0.1
+Summary: CLI finder for LinkinPy integration
+Project-URL: Homepage, https://github.com/HenriquesLab/LinkinPy
+Project-URL: Repository, https://github.com/HenriquesLab/LinkinPy
+Project-URL: Issues, https://github.com/HenriquesLab/LinkinPy/issues
+Project-URL: Changelog, https://github.com/HenriquesLab/LinkinPy/blob/main/CHANGELOG.md
+Author-email: brunomsaraiva <bruno.msaraiva2@gmail.com>
+License-Expression: MIT
+License-File: LICENSE.txt
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# linkinpycli
+
+CLI finder for LinkinPy integration
+
+## Quick Start
+
+```bash
+uv sync
+uv run pytest
+```
+
+The project pins its local development interpreter in `.python-version` and keeps package metadata in `pyproject.toml`.
+
+## Common Commands
+
+```bash
+uv sync                  # create/update the local environment
+uv run pytest            # run the test suite
+uv run ruff check .      # lint the codebase
+uv run ruff format .     # format the codebase
+uv run python -m build   # build the source and wheel distributions
+uv run pre-commit install
+```
+
+If you prefer shorter aliases, the same workflow is available through `make`:
+
+```bash
+make sync
+make test
+make lint
+make format
+make build
+```
+
+## Project Layout
+
+```text
+src/linkinpycli/
+tests/
+pyproject.toml
+.python-version
+GETTING_STARTED.md
+CONTRIBUTING.md
+```
+
+## Documentation
+
+- Start with [GETTING_STARTED.md](GETTING_STARTED.md) for first-time setup
+- See [CONTRIBUTING.md](CONTRIBUTING.md) for the contributor workflow
+- Track user-facing changes in [CHANGELOG.md](CHANGELOG.md)

linkinpycli-0.0.1.dist-info/RECORD

@@ -0,0 +1,8 @@
+linkinpycli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+linkinpycli/crawler.py,sha256=lPhzleGG4JJCV2VuLIr3uQehVkKXwh-5dmVXyL13gU0,571
+linkinpycli/linkinpycli.py,sha256=ZEHSOgjlfiVER4Jh0oE_qThNP599lOxVKhp-zomF-L4,3620
+linkinpycli-0.0.1.dist-info/METADATA,sha256=c3Q8uQ02z0z1zcVhXsVXKPIPjyc9BITte40l7Kcd26c,1834
+linkinpycli-0.0.1.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+linkinpycli-0.0.1.dist-info/entry_points.txt,sha256=9IQg5_h0an5eW-A60MDc6N4Lv34cPGyFQC446H5kf4U,82
+linkinpycli-0.0.1.dist-info/licenses/LICENSE.txt,sha256=WrrpqqQd_VEVy37iiIgoICGcWlYfAsWTsHC44JK0OGM,1079
+linkinpycli-0.0.1.dist-info/RECORD,,

linkinpycli-0.0.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.29.0
+Root-Is-Purelib: true
+Tag: py3-none-any

linkinpycli-0.0.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+linkinpy-parse = linkinpycli.linkinpycli:parse_linkinpy_scripts

linkinpycli-0.0.1.dist-info/licenses/LICENSE.txt

@@ -0,0 +1,22 @@
+
+The MIT License (MIT)
+
+Copyright (c) 2026 linkinpycli
+
+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.