Installation

Prerequisites

Pyxle requires:

  • Python 3.10+ (3.12 recommended)
  • Node.js 20.19+ (for Vite 7, React 19, and SSR). Node 18 is end-of-life and no longer supported.
  • npm (ships with Node.js)

Verify your setup:

python --version   # Python 3.10 or later
node --version     # v20.19 or later
npm --version      # 10 or later

Install Pyxle

Install Pyxle from PyPI:

pip install pyxle-framework

This installs the pyxle CLI and the framework runtime. Confirm it works:

pyxle --version
python -m venv venv
source venv/bin/activate   # macOS / Linux
# venv\Scripts\activate    # Windows
pip install pyxle-framework

What gets installed

The pyxle package includes:

Component Purpose
pyxle CLI Project scaffolding, dev server, build pipeline
pyxle.runtime @server and @action decorators for your .pyxl files
pyxle.config Configuration loading and validation
Starlette ASGI web server (installed as a dependency)
Uvicorn ASGI server runner (installed as a dependency)
pyxle-langkit Language toolkit powering pyxle check's JSX validation (installed as a dependency)

Node.js dependencies (React 19, Vite 7, and — if you opt in — Tailwind CSS v4) are installed per-project via npm install -- they are not global.

Troubleshooting

Two common failures come from an out-of-date toolchain. Both are fixed by upgrading — Pyxle needs Python 3.10+ and Node.js 20.19+.

pip install says "No matching distribution found for pyxle-framework"

ERROR: Could not find a version that satisfies the requirement pyxle-framework (from versions: none)
ERROR: No matching distribution found for pyxle-framework

Your pip is running on Python older than 3.10 (the stock python3 on macOS is 3.9). Pyxle ships no wheels for end-of-life Pythons, so pip reports "none available." Check your version, then install with a supported interpreter:

python3 --version          # must be 3.10 or later

Install a supported Python (via python.org, pyenv, or Homebrew's [email protected]) and create the virtual environment with that interpreter:

python3.12 -m venv venv && source venv/bin/activate
pip install pyxle-framework

pyxle dev / pyxle build stops with a Node.js version error

If node --version is below v20.19, Pyxle stops with a clear message before starting Vite:

Node.js 20.19+ is required, but 20.16.0 is installed.

Vite 7 — which Pyxle uses to build and serve your React code — requires Node.js 20.19 or newer; older 20.x releases crash at startup. Upgrade Node and re-run:

node --version             # must be v20.19 or later
nvm install 20             # if you use nvm
# or download the latest LTS from https://nodejs.org

Next steps

Create your first project: Quick Start

PreviousIntroductionNextQuick Start