Skip to main content

Local Orion CLI launcher for notebooks and Jupyter

Project description

orion-notebook

Python launcher for Orion. Installs the orion command on PyPI.

Install

pip install orion-notebook
orion

What happens on first run

The PyPI wheel is intentionally small. When you run orion for the first time, the CLI may:

  1. Download the Orion app bundle into ~/.orion/app/<version> from a GitHub release
  2. Download portable Node.js 20+ into ~/.orion/runtime/node/<version> if Node is not installed
  3. Create an Orion-managed Jupyter venv under ~/.orion/runtime/venv if no compatible Jupyter is found

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+
  • Node.js 20+ (downloaded automatically into ~/.orion/runtime/node when missing)

Flags

orion --yes          # auto-approve setup prompts
orion --no-browser   # start services without opening a browser

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 alternative

If you already have Node.js 20+, the npm package is simpler because it ships the app bundle directly:

npm install -g @nicolasakf/orion-agent
orion

See the main README and Contributing for publishing and development details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

orion_notebook-0.5.0.tar.gz (6.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

orion_notebook-0.5.0-py3-none-any.whl (6.9 kB view details)

Uploaded Python 3

File details

Details for the file orion_notebook-0.5.0.tar.gz.

File metadata

  • Download URL: orion_notebook-0.5.0.tar.gz
  • Upload date:
  • Size: 6.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for orion_notebook-0.5.0.tar.gz
Algorithm Hash digest
SHA256 b247c656cbf42df43fd173c07cb47392f3ec6921e3ec08f1c2fb0d7aebbc218b
MD5 568ff46d79916b2b5141e3b8b6048928
BLAKE2b-256 0e51b4eaf2c357a398afd0e6c7ae066d18d9bd0f9bf697c167d34fadbfb38b7c

See more details on using hashes here.

File details

Details for the file orion_notebook-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: orion_notebook-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 6.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for orion_notebook-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9bfbb3dbbf676a6db5e999a9acb4883fe427ee56903d5c9b8cf7ee52c44913bd
MD5 6b32ef122183e784f45bbca0624f2752
BLAKE2b-256 1bef2a0685d74fa0a7cc43bc00417941e92d0978b5b084e4cf48cc0bc808869d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page