orion-notebook
Python launcher for Orion. Installs the orion command on PyPI.
Orion also publishes orion-ui on PyPI — the Python library for notebook UI components (import orion_ui as ui). You do not install it separately when using Orion's managed Jupyter runtime; Orion syncs orion-ui==<version> into ~/.orion/runtime/venv automatically.
Install
pip install orion-notebook
orion
The website one-liner may also install this package with uv tool install when npm and pip are unavailable.
What happens on first run
The PyPI wheel is intentionally small. When you run orion for the first time, the CLI may:
- Download the Orion app bundle into
~/.orion/app/<version>from a GitHub release - Download portable Node.js 20+ into
~/.orion/runtime/node/<version>if Node is not installed - Create an Orion-managed Jupyter venv under
~/.orion/runtime/venvif no compatible Jupyter is found (includes Jupyter, ipykernel, andorion-ui)
Each step prompts for consent unless you pass --yes:
orion --yes
Managed Jupyter is installed only inside Orion's venv, not into your global Python.
After the first successful setup, later runs start Jupyter, launch Orion, and open your browser much faster.
Requirements
- Python 3.8+ for direct
pip install; the website installer can use uv-managed Python when needed - Node.js 20+ (downloaded automatically into
~/.orion/runtime/nodewhen missing)
Flags
orion --yes # auto-approve setup prompts
orion --no-browser # start services without opening a browser
orion uninstall # remove cached app bundle for this version (~/.orion/app/<version>)
orion uninstall --all --yes # remove entire ~/.orion directory
Uninstall
pip uninstall orion-notebook removes the Python launcher only. It does not delete the app bundle downloaded into ~/.orion/app/<version>/. Run this first:
orion uninstall --yes
pip uninstall orion-notebook
# or, if installed by the website uv fallback:
uv tool uninstall orion-notebook
To remove all Orion-managed data (Jupyter venv, portable Node, every cached app version):
orion uninstall --all --yes
Environment variables
| Variable | Purpose |
|---|---|
ORION_HOME_DIR |
Override Orion data root (default: ~/.orion) |
ORION_APP_BUNDLE_URL |
Override app bundle download URL |
ORION_PORT |
Orion app port (default: 3001) |
Default app bundle URL:
https://github.com/nicolasakf/Orion-app/releases/download/v<version>/orion-app-<version>.tar.gz
npm install (recommended)
Both npm and PyPI publish under the name orion-notebook. If you already have Node.js 20+, npm is simpler because it ships the app bundle directly:
npm install -g orion-notebook
orion
See the main README and Contributing for publishing and development details.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file orion_notebook-0.17.0.tar.gz.
File metadata
- Download URL: orion_notebook-0.17.0.tar.gz
- Upload date:
- Size: 26.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
afc7348ee593a17c7d61d98605a5b53af16871fe448f2abe495ef7bbf9eb2e6c
|
|
| MD5 |
fc2be779e98939832549defdb46cfb46
|
|
| BLAKE2b-256 |
75c1645318a56e761865f61ca4e411a7a77b04c84d8b05d213c218b56f2d7000
|
File details
Details for the file orion_notebook-0.17.0-py3-none-any.whl.
File metadata
- Download URL: orion_notebook-0.17.0-py3-none-any.whl
- Upload date:
- Size: 17.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e15e2e0dd6769f8047e60c54d9c49fee3ec5eed5cec387bb8f0f6894bcc16628
|
|
| MD5 |
b56a2d4dcf9bcf8ad43e340b31976f7c
|
|
| BLAKE2b-256 |
554ec68522f11f6fc1d87d1c7c1845f3dd807d34cf8d8a987508a866aa5c9144
|
