Metadata-Version: 2.4
Name: orion-notebook
Version: 0.5.0
Summary: Local Orion CLI launcher for notebooks and Jupyter
Author: Nicolas Fonteyne
License: Apache-2.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown

# orion-notebook

Python launcher for [Orion](https://www.orion-agent.ai). Installs the `orion` command on PyPI.

## Install

```bash
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`:

```bash
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

```bash
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:

```text
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:

```bash
npm install -g @nicolasakf/orion-agent
orion
```

See the [main README](../README.md) and [Contributing](../CONTRIBUTING.md#publishing-the-cli) for publishing and development details.
