Installation

XY 0.0.1 supports Python 3.11 and newer. Install the released core package from PyPI with your preferred package manager:

Confirm the package imports from the environment where your code will run:

XY supports the platforms below. The PyPI column describes only the files in the current 0.0.1 upload, not whether XY supports the platform.

Windows is supported by XY's native core and release pipeline. The current 0.0.1 PyPI upload does not include Windows wheels or a source distribution, so uv add xy and python -m pip install xy cannot install it directly on Windows yet. Until a Windows wheel is published, install the tagged source with a Rust MSVC toolchain as described below.

A runtime-verified Pyodide wheel has been built for in-browser Python, but the v0.0.1 wheel is not yet publicly distributed as a durable release asset. PyPI does not accept its pyodide_2025_0_wasm32 platform tag, so the WASM wheel is not available through the normal install commands. This target runs XY's Python and Rust core inside Pyodide; it is separate from the JavaScript/WebGL client included with every chart. Track publication in #97.

The regular xy dependency already includes NumPy and anywidget support. Published platform wheels bundle the Python package, browser client, and native Rust compute core. Notebook display and HTML, native PNG, and SVG export do not require separate notebooks or export extras, Node, npm, or a CDN.

Use the PyPI wheel when your platform is supported. A working source install must compile the native compute core, so it requires a Rust toolchain with cargo and rustc. The browser client is committed to the repository; Node and npm are not required just to install it.

To reproduce the 0.0.1 release from Git with uv:

Or install the same tagged source with pip:

A source build without Rust can finish installing, but it has no compute backend and fails with an actionable error when a chart first needs native compute. XY does not silently switch to a slower implementation. Building for an unsupported operating system or architecture may also require target-specific Rust tooling beyond the commands above.

• Install pyarrow separately when you want Arrow-backed input:
• The separate Reflex adapter supports state-backed application charts, but it is experimental and is not published on PyPI. Opt in by pairing the released xy core with the adapter from the matching v0.0.1 Git tag. With uv:
• Or with pip:
• The tag keeps the unreleased adapter aligned with the public 0.0.1 core. Continue with the Reflex integration guide for its current limitations and setup.
• Native PNG is the default static raster path and does not launch a browser. Chromium-based PNG export is optional and discovers Chrome, Chromium, Edge, or chrome-headless-shell on the machine; set XY_BROWSER to an executable path when automatic discovery is not appropriate.

Next, build your first chart.