Installation

Installation

Abstract

PYNE is live on PyPI as hoox-pyne (currently 0.3.14+). The import package remains pynescript (src-layout under src/pynescript/). Preferred console scripts are pyne / pyne-lsp; legacy pynescript / pynescript-lsp remain installed as aliases.

Do not install:

• plain pyne / PyNE from PyPI without the hoox- prefix — unrelated 0.1.0 process-networking library (our wheel is hoox-pyne)
• upstream pynescript (elbakramer) — different project

pip install hoox-pyne
pip install "hoox-pyne[lsp]"       # language server
pip install "hoox-pyne[compile]"   # Numba compile path
pip install "hoox-pyne[data]"      # ccxt market data
pip install "hoox-pyne[pro]"       # Flask Pro API stack

Conceptual model

Rendering…

Interface surface

Prerequisites

• Python ≥ 3.10 (classifiers declare 3.10–3.13)
• pip or an equivalent installer; virtualenv strongly recommended
• Optional: Docker for the CLI image; Node 22+ only if building the VS Code extension

Core install (PyPI)

python3 -m venv .venv
source .venv/bin/activate   # Windows: .venv\Scripts\activate
pip install -U pip
pip install "hoox-pyne[lsp,compile]"
pyne --version
pyne info

Project page: pypi.org/project/hoox-pyne · owner account jango-blockchained.

Extras

Defined in pyproject.toml under [project.optional-dependencies]:

pip install "hoox-pyne[lsp]"
pip install "hoox-pyne[compile]"
pip install "hoox-pyne[data]"      # alias: datafeed
pip install "hoox-pyne[pro]"
pip install "hoox-pyne[lsp,compile,data]"

Source checkout

git clone https://github.com/hoox-sh/pyne.git
cd pyne
pip install -e ".[lsp,pro]"
# or:
make install

Docker CLI

docker pull   # when published to a registry; or build from source:
git clone https://github.com/hoox-sh/pyne.git && cd pyne
make docker-build-cli
docker run --rm -v "$PWD:/work" -w /work pynescript-cli:latest check script.pine
# ≡ make docker-cli ARGS="check script.pine"

Console scripts

pyne --version
pyne --help
pyne check script.pine
which pyne-lsp   # only after [lsp]

Standalone binaries and a CLI image tarball also ship on GitHub Releases.

Internals (repo paths)

Invariants & edge cases

• PyPI name ≠ import name. Install hoox-pyne; import pynescript. CLIs: pyne / pyne-lsp.
• License. AGPL-3.0-or-later. Network use triggers AGPL source-offer obligations (see GNU AGPL §13).
• LSP is not a CLI subcommand. Use pyne-lsp (or python -m pynescript.langserver).
• Pro API. pip install "hoox-pyne[pro]" or monorepo pip install -r backend/requirements.txt + make run (default :5002).
• Source extensions. Prefer .pyne for stack sources; .pine / .pinev5 / .pinev6 still work.

Worked examples

Smoke-test CLI and library

python - <<'PY'
from pynescript.ast import parse, unparse
from pynescript import __about__
print("version", __about__.__version__)
src = '//@version=6\nindicator("t")\nplot(close)\n'
print(unparse(parse(src)))
PY

pyne check examples/rsi_strategy.pine
pyne lint examples/rsi_strategy.pine
# optional (needs [compile] for Numba):
# pyne prewarm
# pyne run examples/rsi_strategy.pine --bars 50

Monorepo desk + Pro API

git clone https://github.com/hoox-sh/pyne.git
cd pyne
pip install -e ".[lsp,pro]"
make run   # Flask on :5002

Failure modes

See also

• Quick start
• CLI guide
• Editors / LSP
• PyPI publish (maintainers)
• End User hub