ray-pixi 0.1.0__tar.gz

ray_pixi-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,36 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          fetch-depth: 0 # full history + tags so hatch-vcs can resolve the version
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          python-version: "3.13"
+          enable-cache: true
+
+      - name: Install dependencies
+        run: uv sync --locked
+
+      - name: Ruff lint
+        run: uv run ruff check --output-format=github .
+
+      - name: Ruff format check
+        run: uv run ruff format --check .
+
+      - name: Type check (ty)
+        run: uv run ty check

ray_pixi-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,80 @@
+name: Release
+
+on:
+  push:
+    tags: ["v*"]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          fetch-depth: 0 # full history + tags so hatch-vcs resolves the version
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          python-version: "3.13"
+          enable-cache: true
+
+      - name: Install dependencies
+        run: uv sync --locked
+
+      - name: Lint, format, type check
+        run: |
+          uv run ruff check .
+          uv run ruff format --check .
+          uv run ty check
+
+      - name: Test
+        run: uv run pytest
+
+      - name: Build sdist and wheel
+        run: uv build
+
+      - name: Upload dist artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  pypi-publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/ray-pixi
+    permissions:
+      id-token: write # OIDC token for PyPI Trusted Publishing
+    steps:
+      - name: Download dist artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+  github-release:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write # create the release and upload assets
+    steps:
+      - name: Download dist artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Create GitHub Release
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: >
+          gh release create "${{ github.ref_name }}"
+          dist/*
+          --repo "${{ github.repository }}"
+          --title "${{ github.ref_name }}"
+          --generate-notes

ray_pixi-0.1.0/.gitignore

@@ -0,0 +1,221 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+.vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+# superpowers (brainstorming specs / plans — kept local only)
+docs/superpowers/

ray_pixi-0.1.0/.python-version

@@ -0,0 +1 @@
+3.13

ray_pixi-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 ZhengYu, Xu
+
+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.

ray_pixi-0.1.0/PKG-INFO

@@ -0,0 +1,132 @@
+Metadata-Version: 2.4
+Name: ray-pixi
+Version: 0.1.0
+Summary: Add your description here
+Author-email: ZhengYu Xu <zen-xu@outlook.com>
+License-File: LICENSE
+Requires-Python: >=3.13
+Requires-Dist: pydantic>=2
+Requires-Dist: ray>=2.50
+Requires-Dist: tomli-w>=1.0
+Description-Content-Type: text/markdown
+
+# ray-pixi
+
+A [pixi](https://pixi.sh) `runtime_env` for [Ray](https://ray.io): declare a pixi
+environment in your `runtime_env`, and Ray installs it on each node and launches
+the workers inside it via `pixi run`.
+
+## Install
+
+```bash
+pip install ray-pixi      # or: pixi add --pypi ray-pixi
+```
+
+## Plugin registration
+
+Ray discovers runtime_env plugins through the `RAY_RUNTIME_ENV_PLUGINS`
+environment variable, which **must be set before the runtime_env agent starts** —
+that is, before `ray start` on every node (and before `ray.init()` for a local
+cluster):
+
+```bash
+export RAY_RUNTIME_ENV_PLUGINS='[{"class":"ray_pixi.PixiPlugin"}]'
+ray start --head          # or: ray start --address=...
+```
+
+On KubeRay / a cluster YAML, set the same value in each node's container env.
+ray-pixi must also be installed in the agent's Python environment on every node
+(so it can import `ray_pixi.PixiPlugin`).
+
+## Usage
+
+Once the variable is set, declare the environment with `pixi()`:
+
+```python
+import ray
+
+from ray_pixi import pixi
+
+ray.init(runtime_env={"pixi": pixi("pixi.toml", environment="default", locked=True)})
+
+
+@ray.remote
+def task():
+    import numpy
+
+    return numpy.__version__
+
+
+print(ray.get(task.remote()))
+```
+
+You can also declare the environment inline, without a manifest file:
+
+```python
+ray.init(
+    runtime_env={
+        "pixi": pixi(
+            channels=["conda-forge"],
+            dependencies={"python": "3.13.*", "numpy": "*"},
+        )
+    }
+)
+```
+
+## The `pixi` field
+
+`runtime_env["pixi"]` accepts a `str` (a manifest path) or a `dict`:
+
+| key | description |
+| --- | --- |
+| `manifest` | path to a `pixi.toml` / `pyproject.toml` (mutually exclusive with the inline keys) |
+| `channels` / `dependencies` / `pypi_dependencies` / `platforms` | inline spec |
+| `environment` | environment to select, defaults to `default` |
+| `locked` | reproduce strictly from `pixi.lock`, defaults to `False` |
+| `pixi_version` | if set, bootstrap this pixi version on the node |
+| `pixi_install_options` | extra flags passed through to `pixi install` |
+
+Prefer building the field with `ray_pixi.pixi()`: given a manifest path it reads
+the file (and a sibling `pixi.lock`) on the driver and inlines the content, so the
+configuration is self-contained across nodes.
+
+> **Requirements:** every node needs a `pixi` executable (on `PATH`, or bootstrapped
+> via `pixi_version`), and the pixi environment must provide a `python` and `ray`
+> that match the cluster (see *Version matching* below).
+
+## Version matching
+
+Ray refuses to connect a worker whose `ray` or `python` version differs from the
+cluster. Concretely:
+
+- **Ray version** is always compared exactly — declare the cluster's exact version.
+- **Python version** is compared at the level set by the cluster's
+  `RAY_DEFAULT_PYTHON_VERSION_MATCH_LEVEL` environment variable:
+  - `patch` (Ray's default) — must match down to the micro version
+    (`3.13.12` ≠ `3.13.13`), or Ray errors.
+  - `minor` — only `major.minor` must match; a micro difference just warns. Set
+    `RAY_DEFAULT_PYTHON_VERSION_MATCH_LEVEL=minor` on the cluster to allow this.
+
+How ray-pixi helps:
+
+- **Inline mode:** if you omit `python` from `dependencies` it is pinned to the
+  node's exact running version, and if you omit `ray` from `pypi_dependencies` it is
+  added as `ray[default]==<cluster ray version>`, so workers match by default.
+- **Manifest mode:** ray-pixi does **not** edit your manifest, so it must declare
+  both `python` and `ray` itself (ray as a pypi dependency). A manifest that installs
+  neither is rejected after install with a clear error.
+- **Both modes:** after installing, ray-pixi verifies the env's python *minor* and
+  *ray* version against the cluster and fails fast (with a clear error) on a
+  mismatch. The python check is minor-level only, so under the default `patch` level
+  still pin `python` to the cluster's exact version (e.g. `python = "==3.13.12"` in
+  your manifest), or relax the cluster to `minor`.
+
+## Known interactions
+
+- **Launching the driver with `uv run`:** Ray's built-in uv integration
+  (`RAY_ENABLE_UV_RUN_RUNTIME_ENV`, on by default) detects the `uv run` ancestor and
+  tries to rewrite `py_executable` to replicate the uv environment, which conflicts
+  with the pixi plugin. Disable it when using pixi:
+  `RAY_ENABLE_UV_RUN_RUNTIME_ENV=0`.
+- **`platforms`:** when you declare an inline spec without `platforms`, ray-pixi
+  defaults it to the building node's platform (e.g. `linux-64`).

ray_pixi-0.1.0/README.md

@@ -0,0 +1,120 @@
+# ray-pixi
+
+A [pixi](https://pixi.sh) `runtime_env` for [Ray](https://ray.io): declare a pixi
+environment in your `runtime_env`, and Ray installs it on each node and launches
+the workers inside it via `pixi run`.
+
+## Install
+
+```bash
+pip install ray-pixi      # or: pixi add --pypi ray-pixi
+```
+
+## Plugin registration
+
+Ray discovers runtime_env plugins through the `RAY_RUNTIME_ENV_PLUGINS`
+environment variable, which **must be set before the runtime_env agent starts** —
+that is, before `ray start` on every node (and before `ray.init()` for a local
+cluster):
+
+```bash
+export RAY_RUNTIME_ENV_PLUGINS='[{"class":"ray_pixi.PixiPlugin"}]'
+ray start --head          # or: ray start --address=...
+```
+
+On KubeRay / a cluster YAML, set the same value in each node's container env.
+ray-pixi must also be installed in the agent's Python environment on every node
+(so it can import `ray_pixi.PixiPlugin`).
+
+## Usage
+
+Once the variable is set, declare the environment with `pixi()`:
+
+```python
+import ray
+
+from ray_pixi import pixi
+
+ray.init(runtime_env={"pixi": pixi("pixi.toml", environment="default", locked=True)})
+
+
+@ray.remote
+def task():
+    import numpy
+
+    return numpy.__version__
+
+
+print(ray.get(task.remote()))
+```
+
+You can also declare the environment inline, without a manifest file:
+
+```python
+ray.init(
+    runtime_env={
+        "pixi": pixi(
+            channels=["conda-forge"],
+            dependencies={"python": "3.13.*", "numpy": "*"},
+        )
+    }
+)
+```
+
+## The `pixi` field
+
+`runtime_env["pixi"]` accepts a `str` (a manifest path) or a `dict`:
+
+| key | description |
+| --- | --- |
+| `manifest` | path to a `pixi.toml` / `pyproject.toml` (mutually exclusive with the inline keys) |
+| `channels` / `dependencies` / `pypi_dependencies` / `platforms` | inline spec |
+| `environment` | environment to select, defaults to `default` |
+| `locked` | reproduce strictly from `pixi.lock`, defaults to `False` |
+| `pixi_version` | if set, bootstrap this pixi version on the node |
+| `pixi_install_options` | extra flags passed through to `pixi install` |
+
+Prefer building the field with `ray_pixi.pixi()`: given a manifest path it reads
+the file (and a sibling `pixi.lock`) on the driver and inlines the content, so the
+configuration is self-contained across nodes.
+
+> **Requirements:** every node needs a `pixi` executable (on `PATH`, or bootstrapped
+> via `pixi_version`), and the pixi environment must provide a `python` and `ray`
+> that match the cluster (see *Version matching* below).
+
+## Version matching
+
+Ray refuses to connect a worker whose `ray` or `python` version differs from the
+cluster. Concretely:
+
+- **Ray version** is always compared exactly — declare the cluster's exact version.
+- **Python version** is compared at the level set by the cluster's
+  `RAY_DEFAULT_PYTHON_VERSION_MATCH_LEVEL` environment variable:
+  - `patch` (Ray's default) — must match down to the micro version
+    (`3.13.12` ≠ `3.13.13`), or Ray errors.
+  - `minor` — only `major.minor` must match; a micro difference just warns. Set
+    `RAY_DEFAULT_PYTHON_VERSION_MATCH_LEVEL=minor` on the cluster to allow this.
+
+How ray-pixi helps:
+
+- **Inline mode:** if you omit `python` from `dependencies` it is pinned to the
+  node's exact running version, and if you omit `ray` from `pypi_dependencies` it is
+  added as `ray[default]==<cluster ray version>`, so workers match by default.
+- **Manifest mode:** ray-pixi does **not** edit your manifest, so it must declare
+  both `python` and `ray` itself (ray as a pypi dependency). A manifest that installs
+  neither is rejected after install with a clear error.
+- **Both modes:** after installing, ray-pixi verifies the env's python *minor* and
+  *ray* version against the cluster and fails fast (with a clear error) on a
+  mismatch. The python check is minor-level only, so under the default `patch` level
+  still pin `python` to the cluster's exact version (e.g. `python = "==3.13.12"` in
+  your manifest), or relax the cluster to `minor`.
+
+## Known interactions
+
+- **Launching the driver with `uv run`:** Ray's built-in uv integration
+  (`RAY_ENABLE_UV_RUN_RUNTIME_ENV`, on by default) detects the `uv run` ancestor and
+  tries to rewrite `py_executable` to replicate the uv environment, which conflicts
+  with the pixi plugin. Disable it when using pixi:
+  `RAY_ENABLE_UV_RUN_RUNTIME_ENV=0`.
+- **`platforms`:** when you declare an inline spec without `platforms`, ray-pixi
+  defaults it to the building node's platform (e.g. `linux-64`).

ray_pixi-0.1.0/pyproject.toml

@@ -0,0 +1,58 @@
+[project]
+name = "ray-pixi"
+dynamic = ["version"]
+description = "Add your description here"
+readme = "README.md"
+authors = [
+    { name = "ZhengYu Xu", email = "zen-xu@outlook.com" },
+]
+requires-python = ">=3.13"
+dependencies = ["ray>=2.50", "tomli-w>=1.0", "pydantic>=2"]
+
+[build-system]
+requires = ["hatchling", "hatch-vcs"]
+build-backend = "hatchling.build"
+
+[tool.hatch.version]
+source = "vcs"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/ray_pixi"]
+
+[dependency-groups]
+dev = [
+    "ruff>=0.15",
+    "ty>=0.0.39",
+    "pytest>=8",
+]
+
+[tool.ruff]
+target-version = "py313"
+line-length = 88
+src = ["src"]
+
+[tool.ruff.lint]
+select = [
+    "E",   # pycodestyle errors
+    "W",   # pycodestyle warnings
+    "F",   # pyflakes
+    "I",   # isort
+    "B",   # flake8-bugbear
+    "C4",  # flake8-comprehensions
+    "UP",  # pyupgrade
+    "SIM", # flake8-simplify
+    "RUF", # ruff-specific rules
+]
+
+[tool.ruff.lint.isort]
+known-first-party = ["ray_pixi"]
+
+[tool.ruff.format]
+docstring-code-format = true
+
+[tool.ty.environment]
+root = ["./src"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-ra"

ray_pixi-0.1.0/src/ray_pixi/__init__.py

@@ -0,0 +1,23 @@
+"""ray-pixi: a pixi runtime_env plugin for Ray.
+
+Register the plugin by setting, on every node before it starts::
+
+    RAY_RUNTIME_ENV_PLUGINS = '[{"class": "ray_pixi.PixiPlugin"}]'
+
+The Ray runtime_env agent reads that variable at startup. Build the
+``runtime_env["pixi"]`` field with :func:`pixi`.
+"""
+
+from __future__ import annotations
+
+from importlib.metadata import PackageNotFoundError, version
+
+from ray_pixi.plugin import PixiPlugin
+from ray_pixi.spec import pixi
+
+try:
+    __version__ = version("ray-pixi")
+except PackageNotFoundError:  # package is not installed
+    __version__ = "0.0.0+unknown"
+
+__all__ = ["PixiPlugin", "__version__", "pixi"]