End User Hub

End User Hub

This track is for people who consume PYNE: parse and reformat Pine Script™, lint before upload, evaluate expressions or full scripts against OHLCV (mode=auto / interpret / compile), export alerts (optional L2 webhooks), wire an editor via LSP (.pyne / .pine), or call the HTTP evaluate contract. Contributor internals (grammar regeneration, AST builder, bar-loop semantics) live under Core, Runtime, and DevOps.

Abstract

PYNE exposes one language pipeline through several thin surfaces:

.pyne / .pine source
  → parse (ANTLR4 + ASDL AST)
  → optional: dump | unparse | lint | walk/transform
  → optional: evaluate (literal_eval | Runtime mode=auto|interpret|compile)
  → plots / fill / events / drawings / alerts / metrics
  → optional L2 webhooks (Pro API / edge)

The desk path is the pyne Click CLI (alias pynescript) and pynescript.ast / pynescript.runtime library API (PyPI distribution name hoox-pyne). The TypeScript desk path is PyneTS (bun add @hoox-sh/pynets). The editor path is pyne-lsp (alias pynescript-lsp; stdio; first-class .pyne association). The HTTP path is the Flask Pro API (POST /run with alerts export + webhooks, POST /optimize, preview, backtest). The optional chart is AXIS; the optional trade mesh is HOOX. Evaluation does not require either. Defaults for mode differ by surface — modes.

Conceptual model

Rendering…

Choose your path

1. Getting started

New install, first parse, and environment knobs:

• Installation — PyPI pip install hoox-pyne (import pynescript), extras (lsp, compile, data, pro), Hatch checkout, smoke checks.
• Quick start — Parse → dump → unparse → lint → literal_eval in under ten minutes.
• Configuration — Extras, console scripts, Pro API env vars (ALERT_WEBHOOK_URL, compile cache), editor settings.

2. Operational guides

Daily workflows against the same pipeline:

• CLI — check, format, lint, compile, prewarm, run, optimize, data, …
• Library API — parse, unparse, dump, walk, visitors, transformers, linter, optimize.run_study.
• Evaluate scripts — Expression eval, bar-loop Runtime (mode=auto), strategy events, alerts export, mock vs live data.
• Editors — VS Code (.pyne first-class), Neovim, Zed, Emacs, Helix; clients/ snippets.
• Pro API usage — /run (+ webhook_url / L2 webhooks), /run/batch, /optimize, preview, backtest as a consumer.
• Troubleshooting — Parse failures, recursion limits, missing extras, CORS, auth.

3. Reference

• CLI commands — Full option trees for every Click command.
• Modes — interpret / compile / auto defaults: library interpret, POST /run auto, pyne run compile-only.
• Glossary — AST, series, bar-loop, Runtime, ASDL, and related terms.
• FAQ — Version support, TradingView parity, licensing, AXIS/HOOX boundaries.

Interface surface (consumer map)

Preferred console scripts (aliases in parentheses) are registered in pyproject.toml:

Do not conflate them: lint and parse live on pyne; editor features live on pyne-lsp.

Internals (repo paths)

Consumer-relevant code only — deeper design is linked from each guide:

Invariants & edge cases

• Round-trip is first-class. parse → unparse should preserve semantics; use it to normalize formatting, not as a semantic rewrite.
• Mode split. parse(..., mode="exec") yields a script tree; mode="eval" parses a single expression (used by literal_eval).
• No proprietary host required. Evaluation works offline with mock or supplied OHLCV; AXIS/HOOX are optional.
• Extras are opt-in. Core parse/lint needs only base deps (antlr4-python3-runtime, click, …). LSP needs [lsp]; CCXT paths need [data] / [datafeed].
• Optional example dir. pinescript_filepath only expands when --example-scripts-dir points at local *.pine files; no third-party corpus is shipped.

Worked examples

Minimal library round-trip:

from pynescript.ast import parse, unparse

source = """
//@version=6
indicator("My RSI")
plot(ta.rsi(close, 14))
"""
tree = parse(source)
print(unparse(tree))

Minimal CLI:

pip install hoox-pyne
pyne parse-and-dump examples/rsi_strategy.pine
pyne lint examples/rsi_strategy.pine

Minimal HTTP evaluate (local server running):

curl -s http://127.0.0.1:5002/ \
  | python -m json.tool

Failure modes

See also

• PYNE product map — full stack overview
• Installation
• Quick start
• Runtime modes
• Evaluate contract (API)
• AXIS docs — optional chart
• HOOX docs — optional edge trade mesh