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.1.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.1-py3-none-any.whl (6.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: orion_notebook-0.5.1.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.1.tar.gz
Algorithm Hash digest
SHA256 bcceee0af3ef3cdd4b9c8e0314f97d7fbb9957948b48171b89a459cb9c249b4c
MD5 d6fdc8a457076a97a6822933150758bf
BLAKE2b-256 62980b62f572297cf0073582c7090023ffdc6104b27973972fd06173c326db3a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: orion_notebook-0.5.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 be49e80764a89c702008fbc592e7581f211c05b316221389e44eef9dca1c4211
MD5 1ae03f6163da32eaeb6402d28d5e415f
BLAKE2b-256 027c17235fe34e2a75d3c5ad44f9debc970d16a2bf7245ab8659ed1ae41ee891

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