rostree 0.1.0__tar.gz

rostree-0.1.0/.gitignore

@@ -0,0 +1,70 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Virtual environments
+.venv/
+venv/
+ENV/
+env/
+
+# uv
+.uv/
+uv.lock
+
+# Pytest / coverage
+.pytest_cache/
+.coverage
+.coverage.*
+htmlcov/
+.tox/
+.nox/
+
+# Node / frontend
+node_modules/
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+.npm
+.eslintcache
+*.tsbuildinfo
+rosdep_viz_webapp/frontend/dist/
+
+# IDE / editor
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Env / secrets
+.env
+.env.local
+.env.*.local
+
+# Misc
+*.log
+.cache/

rostree-0.1.0/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2026, The rosdep_viz authors
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

rostree-0.1.0/PKG-INFO

@@ -0,0 +1,82 @@
+Metadata-Version: 2.4
+Name: rostree
+Version: 0.1.0
+Summary: Explore ROS 2 package dependencies from the command line (CLI, TUI, library)
+Author: rostree contributors
+License: MIT
+License-File: LICENSE
+Keywords: cli,dependencies,ros,ros2,tui,visualization
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Requires-Python: >=3.10
+Requires-Dist: textual>=0.47.0
+Provides-Extra: dev
+Requires-Dist: black==25.1.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff>=0.1.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# rostree
+
+[![CI](https://github.com/guilyx/rostree/actions/workflows/ci.yml/badge.svg)](https://github.com/guilyx/rostree/actions/workflows/ci.yml)
+[![codecov](https://codecov.io/gh/guilyx/rostree/graph/badge.svg)](https://codecov.io/gh/guilyx/rostree)
+[![PyPI version](https://img.shields.io/pypi/v/rostree.svg)](https://pypi.org/project/rostree/)
+[![PyPI downloads](https://img.shields.io/pypi/dm/rostree.svg)](https://pypi.org/project/rostree/)
+[![Python versions](https://img.shields.io/pypi/pyversions/rostree.svg)](https://pypi.org/project/rostree/)
+[![License](https://img.shields.io/github/license/guilyx/rostree.svg)](https://github.com/guilyx/rostree/blob/main/LICENSE)
+
+Explore ROS 2 package dependencies from the command line (CLI, TUI, library).
+
+**Docs:** [docs/README.md](docs/README.md) — overview, package discovery, dependency trees, usage, development.
+
+## Quick start
+
+```bash
+pip install -e .   # or: uv pip install -e .
+source /opt/ros/<distro>/setup.bash   # and/or your workspace install/setup.bash
+```
+
+### CLI commands
+
+```bash
+rostree                      # Launch interactive TUI
+rostree scan                 # Scan host for ROS 2 workspaces
+rostree scan ~/dev --depth 3 # Scan specific directories
+rostree list                 # List known packages
+rostree list --by-source     # List packages grouped by source
+rostree tree rclpy           # Show dependency tree for a package
+rostree tree rclpy --depth 3 # Limit tree depth
+rostree tree rclpy --json    # Output as JSON
+```
+
+### TUI mode
+
+```bash
+rostree tui                  # Interactive terminal UI
+rostree tui rclpy            # Start TUI with a specific package tree
+```
+
+### Python API
+
+```python
+from rostree import list_known_packages, get_package_info, build_tree, scan_workspaces
+
+packages = list_known_packages()
+root = build_tree("rclpy", max_depth=5, runtime_only=True)
+workspaces = scan_workspaces()  # Scan host for ROS 2 workspaces
+```
+
+## Links
+
+- [How the system works](docs/overview.md)
+- [How packages are found](docs/package-discovery.md) (workspaces, AMENT_PREFIX_PATH, COLCON_WORKSPACE)
+- [Dependency trees](docs/dependency-trees.md) (package.xml, runtime_only)
+- [Usage](docs/usage.md) (CLI, TUI keys, API)
+- [Development](docs/development.md) (layout, pre-commit, CI)

rostree-0.1.0/README.md

@@ -0,0 +1,57 @@
+# rostree
+
+[![CI](https://github.com/guilyx/rostree/actions/workflows/ci.yml/badge.svg)](https://github.com/guilyx/rostree/actions/workflows/ci.yml)
+[![codecov](https://codecov.io/gh/guilyx/rostree/graph/badge.svg)](https://codecov.io/gh/guilyx/rostree)
+[![PyPI version](https://img.shields.io/pypi/v/rostree.svg)](https://pypi.org/project/rostree/)
+[![PyPI downloads](https://img.shields.io/pypi/dm/rostree.svg)](https://pypi.org/project/rostree/)
+[![Python versions](https://img.shields.io/pypi/pyversions/rostree.svg)](https://pypi.org/project/rostree/)
+[![License](https://img.shields.io/github/license/guilyx/rostree.svg)](https://github.com/guilyx/rostree/blob/main/LICENSE)
+
+Explore ROS 2 package dependencies from the command line (CLI, TUI, library).
+
+**Docs:** [docs/README.md](docs/README.md) — overview, package discovery, dependency trees, usage, development.
+
+## Quick start
+
+```bash
+pip install -e .   # or: uv pip install -e .
+source /opt/ros/<distro>/setup.bash   # and/or your workspace install/setup.bash
+```
+
+### CLI commands
+
+```bash
+rostree                      # Launch interactive TUI
+rostree scan                 # Scan host for ROS 2 workspaces
+rostree scan ~/dev --depth 3 # Scan specific directories
+rostree list                 # List known packages
+rostree list --by-source     # List packages grouped by source
+rostree tree rclpy           # Show dependency tree for a package
+rostree tree rclpy --depth 3 # Limit tree depth
+rostree tree rclpy --json    # Output as JSON
+```
+
+### TUI mode
+
+```bash
+rostree tui                  # Interactive terminal UI
+rostree tui rclpy            # Start TUI with a specific package tree
+```
+
+### Python API
+
+```python
+from rostree import list_known_packages, get_package_info, build_tree, scan_workspaces
+
+packages = list_known_packages()
+root = build_tree("rclpy", max_depth=5, runtime_only=True)
+workspaces = scan_workspaces()  # Scan host for ROS 2 workspaces
+```
+
+## Links
+
+- [How the system works](docs/overview.md)
+- [How packages are found](docs/package-discovery.md) (workspaces, AMENT_PREFIX_PATH, COLCON_WORKSPACE)
+- [Dependency trees](docs/dependency-trees.md) (package.xml, runtime_only)
+- [Usage](docs/usage.md) (CLI, TUI keys, API)
+- [Development](docs/development.md) (layout, pre-commit, CI)

rostree-0.1.0/pyproject.toml

@@ -0,0 +1,62 @@
+[project]
+name = "rostree"
+version = "0.1.0"
+description = "Explore ROS 2 package dependencies from the command line (CLI, TUI, library)"
+readme = "README.md"
+requires-python = ">=3.10"
+license = { text = "MIT" }
+authors = [{ name = "rostree contributors" }]
+keywords = ["ros2", "ros", "dependencies", "visualization", "tui", "cli"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Scientific/Engineering :: Visualization",
+    "Environment :: Console",
+]
+dependencies = [
+    "textual>=0.47.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "black==25.1.0",
+    "pytest>=7.0",
+    "pytest-cov>=4.0",
+    "ruff>=0.1.0",
+]
+
+[project.scripts]
+rostree = "rostree.cli:main"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/rostree"]
+
+[tool.hatch.build.targets.sdist]
+include = ["src/rostree"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+
+[tool.black]
+line-length = 100
+target-version = ["py310"]
+include = '\.pyi?$'
+extend-exclude = '''
+/(
+  \.git
+  | \.venv
+)/
+'''
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["src"]

rostree-0.1.0/src/rostree/__init__.py

@@ -0,0 +1,20 @@
+"""rostree: visualize ROS 2 package dependencies as a tree (library, TUI, CLI)."""
+
+from rostree.api import (
+    build_tree,
+    get_package_info,
+    list_known_packages,
+    list_known_packages_by_source,
+    scan_workspaces,
+    WorkspaceInfo,
+)
+
+__all__ = [
+    "build_tree",
+    "get_package_info",
+    "list_known_packages",
+    "list_known_packages_by_source",
+    "scan_workspaces",
+    "WorkspaceInfo",
+]
+__version__ = "0.1.0"

rostree-0.1.0/src/rostree/api.py

@@ -0,0 +1,117 @@
+"""Public API: use rostree from Python or from other tools."""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+from rostree.core.finder import (
+    find_package_path,
+    list_package_paths,
+    list_packages_by_source,
+    scan_for_workspaces,
+    WorkspaceInfo,
+)
+from rostree.core.parser import parse_package_xml, PackageInfo
+from rostree.core.tree import DependencyNode, build_dependency_tree
+
+
+def list_known_packages(
+    *,
+    extra_source_roots: list[Path] | None = None,
+) -> dict[str, Path]:
+    """
+    List all ROS 2 packages visible in the current environment.
+
+    Uses AMENT_PREFIX_PATH, COLCON_PREFIX_PATH, workspace source trees,
+    and optional extra_source_roots (user-added paths).
+    Returns a mapping from package name to path to its package.xml.
+    """
+    return list_package_paths(extra_source_roots=extra_source_roots)
+
+
+def list_known_packages_by_source(
+    *,
+    extra_source_roots: list[Path] | None = None,
+) -> dict[str, list[str]]:
+    """
+    List packages grouped by source (System, Workspace, Other, Source, Added).
+
+    Lets you distinguish your workspace packages from ROS distro (System),
+    third-party (Other), unbuilt source (Source), and user-added (Added).
+    Returns dict mapping source_label -> sorted list of package names.
+    """
+    return list_packages_by_source(extra_source_roots=extra_source_roots)
+
+
+def get_package_info(
+    package_name: str,
+    *,
+    extra_source_roots: list[Path] | None = None,
+) -> PackageInfo | None:
+    """
+    Get metadata and dependencies for a ROS 2 package by name.
+
+    Finds the package (install or source) and parses its package.xml.
+    Returns None if the package is not found or package.xml cannot be parsed.
+    """
+    path = find_package_path(package_name, extra_source_roots=extra_source_roots)
+    if path is None:
+        return None
+    return parse_package_xml(path)
+
+
+def build_tree(
+    root_package: str,
+    *,
+    max_depth: int | None = None,
+    include_buildtool: bool = False,
+    runtime_only: bool = False,
+    extra_source_roots: list[Path] | None = None,
+) -> DependencyNode | None:
+    """
+    Build a full dependency tree for a ROS 2 package.
+
+    Args:
+        root_package: Name of the root package.
+        max_depth: Optional maximum depth; None = unlimited.
+        include_buildtool: Whether to include buildtool dependencies.
+        runtime_only: If True, only depend and exec_depend (faster, smaller tree).
+        extra_source_roots: Optional list of Paths to scan for packages (user-added).
+
+    Returns:
+        Root DependencyNode, or None if root package is not found.
+    """
+    return build_dependency_tree(
+        root_package,
+        max_depth=max_depth,
+        include_buildtool=include_buildtool,
+        runtime_only=runtime_only,
+        extra_source_roots=extra_source_roots,
+    )
+
+
+def scan_workspaces(
+    roots: list[Path] | None = None,
+    *,
+    max_depth: int = 4,
+    include_home: bool = True,
+    include_opt_ros: bool = True,
+) -> list[WorkspaceInfo]:
+    """
+    Scan the host machine for ROS 2 workspaces.
+
+    Args:
+        roots: Directories to start scanning from. Defaults to common locations.
+        max_depth: How deep to recurse when looking for workspaces.
+        include_home: If True and roots is None, include ~/ros*_ws, etc.
+        include_opt_ros: If True and roots is None, include /opt/ros/* distros.
+
+    Returns:
+        List of WorkspaceInfo for each discovered workspace.
+    """
+    return scan_for_workspaces(
+        roots=roots,
+        max_depth=max_depth,
+        include_home=include_home,
+        include_opt_ros=include_opt_ros,
+    )