pixi-ros 0.1.0__py3-none-any.whl

pixi_ros/__init__.py

@@ -0,0 +1,3 @@
+"""Pixi-ROS: A Pixi extension for ROS package management."""
+
+__version__ = "0.1.0"

pixi_ros/cli.py

@@ -0,0 +1,77 @@
+"""Main CLI entry point for pixi-ros."""
+
+from typing import Annotated
+
+import typer
+
+from pixi_ros.init import init_workspace
+from pixi_ros.mappings import get_ros_distros
+
+app = typer.Typer(
+    name="pixi-ros",
+    help="Pixi extension for ROS package management",
+    no_args_is_help=True,
+)
+
+pkg_app = typer.Typer(help="Manage ROS packages")
+app.add_typer(pkg_app, name="pkg")
+
+
+@app.command()
+def init(
+    distro: Annotated[
+        str | None,
+        typer.Option(
+            "--distro",
+            "-d",
+            help="ROS distribution (e.g., humble, iron, jazzy)",
+        ),
+    ] = None,
+):
+    """Initialize pixi.toml for a ROS workspace."""
+    # If distro not provided, prompt user to select one
+    if distro is None:
+        available_distros = get_ros_distros()
+        typer.echo("Available ROS distributions:")
+        for i, d in enumerate(available_distros, 1):
+            typer.echo(f"  {i}. {d}")
+
+        # Prompt for selection
+        selection = typer.prompt(
+            "\nSelect a distribution (enter number or name)",
+            type=str,
+        )
+
+        # Parse selection (either number or name)
+        try:
+            selection_num = int(selection)
+            dist_count = len(available_distros)
+            if 1 <= selection_num <= dist_count:
+                distro = available_distros[selection_num - 1]
+            else:
+                typer.echo(
+                    f"Error: Invalid selection.Please choose 1-{dist_count}",
+                    err=True,
+                )
+                raise typer.Exit(code=1)
+        except ValueError as err:
+            # User entered a name instead of number
+            if selection in available_distros:
+                distro = selection
+            else:
+                typer.echo(
+                    f"Error: '{selection}' is not a valid ROS distribution", err=True
+                )
+                typer.echo(f"Available: {', '.join(available_distros)}", err=True)
+                raise typer.Exit(code=1) from err
+
+    init_workspace(distro)
+
+
+def main():
+    """Entry point for the CLI."""
+    app()
+
+
+if __name__ == "__main__":
+    main()

pixi_ros/config.py

@@ -0,0 +1,34 @@
+"""Configuration handling for pixi-ros."""
+
+from pathlib import Path
+
+
+def find_config_file(start_path: Path | None = None) -> Path | None:
+    """
+    Search for .pixi-ros.toml configuration file.
+
+    Searches upward from start_path (or cwd) until a config file is found.
+
+    Args:
+        start_path: Starting directory for search (defaults to cwd)
+
+    Returns:
+        Path to config file if found, None otherwise
+    """
+    if start_path is None:
+        start_path = Path.cwd()
+
+    current = start_path.resolve()
+
+    # Search upward until we hit the root
+    while True:
+        config_path = current / ".pixi-ros.toml"
+        if config_path.exists():
+            return config_path
+
+        parent = current.parent
+        if parent == current:  # Reached root
+            break
+        current = parent
+
+    return None

pixi_ros/data/README.md

@@ -0,0 +1,56 @@
+# Mapping files
+
+This file contains mappings from ROS package names to their conda package equivalents.
+These are split by channel. e.g. conda-forge.
+
+## Format
+
+The file is based on the rosdep format, with the following structure:
+
+- Keys are ROS package names, as presented in the package.xml (e.g. `udev`, `uncrustify`, `uuid`). 
+- Values are dictionaries mapping channels to lists of conda package names.
+
+Example:
+
+```yaml
+udev:
+  pixi:
+    linux: [libusb, libudev]
+    osx: [libusb]
+    win64: [libusb]
+uncrustify:
+  pixi: [uncrustify]
+unzip:
+  pixi: [unzip]
+uuid:
+  pixi:
+    linux: [libuuid]
+    osx: []
+    win64: []
+virtualenv:
+  pixi: [virtualenv]
+```
+
+## Customization
+
+You can override these mappings by creating your own `pixi-ros/channel.yaml` file in:
+
+1. **Workspace directory** (highest priority): `./pixi-ros/channel.yaml`
+2. **User config directory**: `~/.pixi-ros/channel.yaml`
+3. **Built-in defaults** (these file): Used if no custom file is found
+
+If you use the same channel name it will override the file completely.
+The channel names are not used for specific package lookups, only to find the correct mapping file.
+e.g. if you name the file `foobar.yaml` it will still be able to fetch the packages from other channels.
+
+
+## Fallback Behavior
+
+If a package is not found in channel.yaml, pixi-ros will automatically:
+1. Convert underscores to dashes
+2. Prepend `ros-{distro}-`
+
+For example, `my_custom_package` becomes `ros-humble-my-custom-package`.
+
+## Local packages
+If a package is found in the `src` folder and also defined in the mapping, it will use the local package.

pixi_ros/data/README_PIXI.md.template

@@ -0,0 +1,125 @@
+# Pixi-ROS Workspace
+
+This ROS {distro} workspace is configured to use [Pixi](https://pixi.sh) for dependency management.
+
+## What is Pixi?
+
+Pixi is a modern package manager that uses conda packages. It provides:
+- Fast, reproducible dependency resolution
+- Automatic environment management
+- Reproducible with a lockfile
+- Cross-platform support (Linux, macOS, Windows)
+
+## Getting Started
+
+### 1. Install Dependencies
+
+```bash
+pixi install
+```
+
+This installs all dependencies specified in `pixi.toml` from the configured channels.
+
+### 2. Build the Workspace
+
+```bash
+pixi run build
+```
+
+This runs `colcon build` to compile your ROS packages.
+
+### 3. Run Tests
+
+```bash
+pixi run test
+```
+
+This runs `colcon test` to execute your test suite.
+
+### 4. Clean Build Artifacts
+
+```bash
+pixi run clean
+```
+
+Removes `build/`, `install/`, and `log/` directories.
+
+### 5. Add additional dependencies
+
+```bash
+pixi add <package-name>
+# or for packages you would install with pip/uv/poetry:
+pixi add --pypi <package-name>
+```
+
+This adds new dependencies to `pixi.toml` and installs them.
+
+## Environment Activation
+
+After the first build, pixi will automatically source the ROS setup script (`install/setup.bash`)
+when you enter the pixi environment. This means you don't need to manually source it!
+
+To activate the environment, run:
+
+```bash
+pixi shell
+```
+
+This starts a new shell with the ROS environment activated.
+
+The environment will also be automatically activated when you run commands with `pixi run <command>`.
+
+## Adding Dependencies
+
+### Add a Conda Package
+
+```bash
+pixi add <package-name>
+```
+
+### Add ROS Dependencies
+
+When you add dependencies to your `package.xml` files, run:
+
+```bash
+pixi ros init --distro {distro}
+```
+
+This will update `pixi.toml` with the new dependencies.
+
+## Unavailable Packages
+
+If you see commented-out packages in `pixi.toml` with `# NOT FOUND`, these packages
+were not found in the configured channels. You may need to:
+- Check if the package name is correct
+- Add additional channels with `pixi project channel add <channel-url>`
+- Install the package through pip: `pixi add --pypi <package-name>`
+- Add it to [conda-forge](https://github.com/conda-forge/staged-recipes) or [RoboStack](https://robostack.github.io/Contributing.html)
+
+## Common Issues
+
+### Build Fails
+
+If `pixi run build` fails:
+1. Make sure all dependencies are installed: `pixi install`
+2. Clean and rebuild: `pixi run clean && pixi run build`
+3. Validate the build task is correct for your workspace.
+
+### Environment Issues
+
+If `ros2` commands aren't found:
+1. Run commands through pixi: `pixi run <command>`
+2. Or use a pixi shell: `pixi shell`
+
+## Learn More
+
+- **Pixi Documentation**: https://pixi.sh
+- **RoboStack Documentation**: https://robostack.github.io/
+- **ROS {distro} Documentation**: https://docs.ros.org/en/{distro}/
+- **pixi-ros GitHub**: https://github.com/prefix-dev/pixi-ros
+
+## Channels
+
+This workspace uses the following channels:
+- `https://prefix.dev/robostack-{distro}` - ROS packages
+- `https://prefix.dev/conda-forge` - System dependencies