Configuration

Configuration

Abstract

PYNE is mostly convention-over-config at the library layer: parse and evaluate take explicit arguments rather than a global config file. Configuration appears at three boundaries: install extras (what code is available), process environment (Pro API host, CORS, API keys store), and editor / LSP client settings (diagnostics, formatting, binary path). This page inventories those knobs for end users.

Conceptual model

Rendering…

There is no pynescript.toml (or similar) for core use. Parse, evaluate, and CLI flags are per-invocation.

Interface surface

Package extras (pyproject.toml)

Console scripts

Invoke without scripts on PATH:

python -m pynescript --help
python -m pynescript.langserver

CLI flags that act as “config”

Per-invocation only (no persistence):

lint has no --fix. Structural rewrite is pyne format -w (parse → unparse).

Pro API environment variables

Consumed by backend/app.py and middleware:

Also relevant:

Runtime / evaluate environment variables

Used by pynescript.runtime.Runtime (src/pynescript/runtime/host.py) and the compiler host. backend.runtime is a compat re-export only.

See Series & history, Technical builtins, and Compiler overview.

Local run:

export HOST=127.0.0.1
export PORT=5002
export ALLOWED_ORIGINS="http://localhost:8081,http://127.0.0.1:8081"
export ADMIN_TOKEN="dev-only-token"
export API_KEY_STORE="$PWD/.data/api_keys.json"
python -m backend.app
# or: make run

Data providers

CLI pynescript data / library providers:

Pro API /run optional fields:

timeout_seconds is accepted on Runtime.run, POST /run, and POST /run/batch. Extra keys that are not in the schema still → UNKNOWN_FIELDS.

Operators can also POST /compile/prewarm or run pyne prewarm (and pyne prewarm script.pine …) to warm Numba builtins / script IR caches before interactive traffic. Requires pip install "hoox-pyne[compile]" for full Numba warm-up.

Free-tier Pro API guards (unauthenticated /run) are off by default. Set FREE_TIER_LIMITS=1 to enable FREE_MAX_BARS, FREE_MAX_SCRIPT_CHARS, FREE_MAX_CONCURRENT, FREE_RATE_LIMIT / FREE_RATE_WINDOW_SEC — see Pro API usage.

Editor / LSP client settings

VS Code extension keys (from clients/README.md):

Extension id: hoox-sh.pyne.

Neovim (clients/neovim.lua):

settings = {
  pinescript = {
    formatting = { enabled = true },
    diagnostics = { enabled = true },
    completion = { snippets = true },
  },
}

Zed: language_servers.pynescript.command / arguments: ["--stdio"] — see Editors.

AXIS / frontend coupling (optional)

When running SuperChart Lite PWA against local Flask:

CORS must allow the PWA origin via ALLOWED_ORIGINS.

Internals (repo paths)

Invariants & edge cases

• Unknown JSON fields on Pro API are rejected (UNKNOWN_FIELDS) — schemas are strict.
• CORS defaults exclude arbitrary production domains — set ALLOWED_ORIGINS deliberately.
• Key store default path is production-oriented (/root/...) — always override locally.
• Lint --fail-on only affects process exit code; it does not change which rules run.
• Recursion limit during parse is raised to at least 5000 temporarily inside helper._parse for deep nests; not user-configurable.

Worked examples

Desk-only machine

python -m venv .venv && source .venv/bin/activate
pip install hoox-pyne
# no env vars required
pyne lint strategy.pine --fail-on errors

Editor workstation

pip install "hoox-pyne[lsp]"
# ensure which pyne-lsp  (alias: pynescript-lsp)
# paste clients/neovim.lua or clients/zed.json as documented

Local API + AXIS

pip install -e ".[lsp]"
pip install -r backend/requirements.txt
export API_KEY_STORE="$PWD/.data/api_keys.json"
export ALLOWED_ORIGINS="http://localhost:8081"
make run
# other terminal:
make run-frontend

Scripted Alpha Vantage fetch

export AV_KEY=your_key
pynescript data EUR/USD --provider alphavantage --api-key "$AV_KEY" --period 3mo

Failure modes

See also

• Installation
• Pro API usage
• Editors
• CLI commands
• Runtime modes
• API auth (systems)
• AXIS docs