Adding pixi environment and docs

Pixi support!

Author: 2lian

.github/workflows/python-pixi.yml

@@ -0,0 +1,33 @@
+name: Python - crossplatform
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+        os: [ubuntu-latest, windows-latest, macos-latest]
+
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 10
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - uses: prefix-dev/setup-pixi@v0.9.2
+      with:
+        cache: true
+        environments: zenoh
+    - name: Test with pixi+pytest
+      run: |
+        pixi run -e zenoh pytest ./tests -s

.github/workflows/python-package.yml renamed to .github/workflows/python-pytest.yml

@@ -1,6 +1,3 @@
-# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
-# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
-
 name: Python
 
 on:
@@ -12,6 +9,7 @@ on:
 jobs:
   build:
 
+    timeout-minutes: 10
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false

.github/workflows/ros-pixi.yml

@@ -0,0 +1,29 @@
+name: ROS 2 - crossplatform
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ros-version: ["humble", "jazzy", "kilted"]
+        os: [ubuntu-latest, windows-latest]
+
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 10
+    steps:
+    - uses: actions/checkout@v4
+    - uses: prefix-dev/setup-pixi@v0.9.2
+      with:
+        cache: true
+        environments: ${{ matrix.ros-version }}
+    - name: Test with pixi+pytest
+      run: |
+        pixi run -e ${{ matrix.ros-version }} pytest ./tests -s
+

.github/workflows/ros-pytest.yml

@@ -9,6 +9,7 @@ on:
 jobs:
   build:
 
+    timeout-minutes: 10
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false

.gitignore

@@ -8,3 +8,4 @@ build/
 install/
 log/
 uv.lock
+.pixi

README.md

@@ -1,7 +1,7 @@
 # Asyncio For Robotics
 | Requirements | Compatibility | Tests |
 |---|---|---|
-| [![python](https://img.shields.io/pypi/pyversions/asyncio_for_robotics?logo=python&logoColor=white&label=Python&color=%20blue)](https://pypi.org/project/asyncio_for_robotics/)<br>[![mit](https://img.shields.io/badge/License-MIT-gold)](https://opensource.org/license/mit) | [![zenoh](https://img.shields.io/badge/Zenoh-%3E%3D1.0-blue)](https://zenoh.io/)<br>[![ros](https://img.shields.io/badge/ROS_2-Humble%20%7C%20Jazzy-blue?logo=ros)](https://github.com/ros2) | [![Python](https://github.com/2lian/asyncio-for-robotics/actions/workflows/python-package.yml/badge.svg)](https://github.com/2lian/asyncio-for-robotics/actions/workflows/python-package.yml)<br>[![ROS 2](https://github.com/2lian/asyncio-for-robotics/actions/workflows/ros-pytest.yml/badge.svg)](https://github.com/2lian/asyncio-for-robotics/actions/workflows/ros-pytest.yml) |
+| [![python](https://img.shields.io/pypi/pyversions/asyncio_for_robotics?logo=python&logoColor=white&label=Python&color=%20blue)](https://pypi.org/project/asyncio_for_robotics/)<br>[![mit](https://img.shields.io/badge/License-MIT-gold)](https://opensource.org/license/mit) | [![ros](https://img.shields.io/badge/ROS_2-Humble%20%7C%20Jazzy-blue?logo=ros)](https://github.com/ros2)<br>[![zenoh](https://img.shields.io/badge/Zenoh-%3E%3D1.0-blue)](https://zenoh.io/) | [![Python](https://github.com/2lian/asyncio-for-robotics/actions/workflows/python-package.yml/badge.svg)](https://github.com/2lian/asyncio-for-robotics/actions/workflows/python-package.yml)<br>[![ROS 2](https://github.com/2lian/asyncio-for-robotics/actions/workflows/ros-pytest.yml/badge.svg)](https://github.com/2lian/asyncio-for-robotics/actions/workflows/ros-pytest.yml) |
 
 The Asyncio For Robotics (`afor`) library makes `asyncio` usable with ROS 2, Zenoh and more, letting you write linear, testable, and non-blocking Python code.
 
@@ -20,13 +20,7 @@ better, faster code.
 
 ### Barebone
 
-```bash
-pip install asyncio_for_robotics
-```
-
-### For ROS 2
-
-Compatible with: `jazzy`,`humble` and newer. This library is pure python (>=3.10), so it installs easily.
+Compatible with ROS 2 (`jazzy`,`humble` and newer) out of the box. This library is pure python (>=3.10), so it installs easily.
 
 ```bash
 pip install asyncio_for_robotics
@@ -45,6 +39,7 @@ pip install asyncio_for_robotics[zenoh]
   - [no talking 🦍 show me code 🦍](https://github.com/2lian/asyncio-for-robotics/blob/main/asyncio_for_robotics/example/ros2_pubsub.py)
 - [Usage for software testing](https://github.com/2lian/asyncio-for-robotics/blob/main/tests)
 - [Implement your own protocol](https://github.com/2lian/asyncio-for-robotics/blob/main/own_proto_example.md)
+- [Cross-Platform deployment even with ROS](https://github.com/2lian/asyncio-for-robotics/blob/main/cross_platform.md) [![Pixi Badge](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/prefix-dev/pixi/main/assets/badge/v0.json)](https://pixi.sh)
 
 ## Code sample
 

asyncio_for_robotics/core/_logger.py

@@ -95,7 +95,7 @@ def setup_logger(debug_path: Optional[str] = None):
                 "level": "DEBUG",
                 "formatter": "json",
                 "filename": (
-                    os.path.expanduser(debug_path) + "/debug.log.jsonl"
+                    os.path.join(os.path.expanduser(debug_path) , "debug.log.jsonl")
                     if debug_path is not None
                     else "log.jsonl"
                 ),  # path relative to working dir
@@ -106,7 +106,7 @@ def setup_logger(debug_path: Optional[str] = None):
                 "level": "DEBUG",
                 "formatter": "user",
                 "filename": (
-                    os.path.expanduser(debug_path) + "/debug.log"
+                    os.path.join(os.path.expanduser(debug_path) , "debug.log")
                     if debug_path is not None
                     else "log"
                 ),  # path relative to working dir

cross_platform.md

@@ -0,0 +1,38 @@
+# Cross-Platform deployment
+
+| Python <br>`3.10`, `3.11`, <br>`3.12`, `3.13`, <br>`3.14`  | ROS 2 <br>`humble`, `jazzy`, <br>`kilted` |
+|:---:|:---:|
+| `ubuntu`, <br>`windows`, <br>`macos` | `ubuntu`,<br>`windows` |
+| [![Python - crossplatform](https://github.com/2lian/asyncio-for-robotics/actions/workflows/python-pixi.yml/badge.svg)](https://github.com/2lian/asyncio-for-robotics/actions/workflows/python-pixi.yml) | [![ROS 2 - crossplatform](https://github.com/2lian/asyncio-for-robotics/actions/workflows/ros-pixi.yml/badge.svg)](https://github.com/2lian/asyncio-for-robotics/actions/workflows/ros-pixi.yml) |
+
+## How?
+
+Asyncio is platform-agnostic, thus `asyncio_for_robotics` should be able to run on any Python... which is the case! Our cross-platform CI tests are verifying that.
+
+Wouldn't it be great if you could just install ROS 2 in a virtual environment on any machine? Then install `asyncio_for_robotics` to be left with only a native python interface able to send messages on ROS? 
+
+[The Pixi package manager](https://pixi.sh) allows you to do that! Yes you can use ROS `humble`, `jazzy`, `kilted` on any Linux and even Windows. Pixi shares our vision of making ROS 2 and robotics more accessible.
+
+## Try it out
+
+(You might have PTSD from the ROS installation process, it's okay, don't be scared anymore)
+
+1. Install pixi: https://pixi.sh/latest/installation/
+  - Linux/Mac: `curl -fsSL https://pixi.sh/install.sh | sh`
+  - Windows: `powershell -ExecutionPolicy ByPass -c "irm -useb https://pixi.sh/install.ps1 | iex"`
+2. Clone this repo and `cd` inside with you terminal
+3. Run the examples! `pixi run -e jazzy python3 -m asyncio_for_robotics.example.ros2_pubsub`
+  - Installation `pixi install` is done automatically before running.
+  - You can replace `jazzy` with other ROS distros: `humble`, `jazzy`, `kilted`. Or if you use `zenoh` you will only have zenoh.
+
+
+## For your project
+
+Do not import, depend or inherit from our `pixi.toml`. Our work is a pure Python package distributed through `PyPI`. However, please take inspiration from our `pixi.toml`, and read the Pixi + Robostack tutorials for your ROS project.
+
+To add ROS 2 and `asyncio_for_robotics` to your Pixi environment, simply to add our `PyPI` dependency to a [ROS Pixi environment](https://pixi.sh/latest/tutorials/ros2/):
+
+```toml
+[pypi-dependencies]
+asyncio-for-robotics = "*"
+```