openpinescript 0.1.1__py3-none-any.whl

openpinescript/_engine/package.json

@@ -0,0 +1,94 @@
+{
+  "name": "openpinescript",
+  "version": "0.1.1",
+  "description": "Run TradingView Pine Script locally and offline. Compiles Pine Script v1-v6 to JavaScript and executes it against your own OHLCV data, with indicator, plotting and strategy backtesting output verified against TradingView itself.",
+  "keywords": [
+    "pine-script",
+    "pinescript",
+    "tradingview",
+    "pine-script-v5",
+    "pine-script-v6",
+    "trading",
+    "backtesting",
+    "backtest",
+    "technical-analysis",
+    "indicators",
+    "transpiler",
+    "compiler",
+    "charting",
+    "algorithmic-trading",
+    "ohlcv",
+    "antlr"
+  ],
+  "homepage": "https://github.com/be-thomas/OpenPineScript#readme",
+  "bugs": {
+    "url": "https://github.com/be-thomas/OpenPineScript/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/be-thomas/OpenPineScript.git"
+  },
+  "license": "GPL-3.0-or-later",
+  "author": "be-thomas",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "bin": {
+    "openpinescript": "./dist/cli.mjs"
+  },
+  "files": [
+    "dist",
+    "!dist/**/*.map",
+    "README.md",
+    "LICENSE"
+  ],
+  "sideEffects": false,
+  "scripts": {
+    "generate:parser": "node scripts/common/build-grammars.mjs",
+    "generate:parser:v1": "node scripts/common/build-grammars.mjs v1",
+    "generate:parser:v2": "node scripts/common/build-grammars.mjs v2",
+    "generate:parser:v3": "node scripts/common/build-grammars.mjs v3",
+    "generate:parser:v4": "node scripts/common/build-grammars.mjs v4",
+    "generate:parser:v5": "node scripts/common/build-grammars.mjs v5",
+    "generate:parser:v6": "node scripts/common/build-grammars.mjs v6",
+    "prebuild": "ts-node scripts/common/generate-metadata.ts",
+    "build": "npm run generate:parser && node scripts/common/build-dist.mjs",
+    "parse": "tsx parser/v2/run_antlr.ts",
+    "replv2": "tsx repl/v2/index.ts",
+    "opsv2": "tsx mock_run/v2/run.ts",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:cov": "vitest run --coverage",
+    "prepare": "npm run generate:parser",
+    "build:dist": "node scripts/common/build-dist.mjs",
+    "prepublishOnly": "npm run build && npm test"
+  },
+  "dependencies": {
+    "antlr4ng": "^3.0.16"
+  },
+  "devDependencies": {
+    "@types/node": "^22.10.2",
+    "antlr-ng": "^1.0.10",
+    "esbuild": "^0.27.0",
+    "ts-morph": "^27.0.2",
+    "ts-node": "^10.9.2",
+    "tsx": "^4.21.0",
+    "typescript": "^5.6.0",
+    "vitest": "^4.0.18"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

openpinescript/_runtime.py

@@ -0,0 +1,29 @@
+"""Locate the Node executable and the vendored engine."""
+import os
+from pathlib import Path
+
+ENGINE_DIR = Path(__file__).resolve().parent / "_engine"
+CLI_JS = ENGINE_DIR / "dist" / "cli.mjs"
+
+
+def node_executable():
+    """The Node binary to run: $OPENPINESCRIPT_NODE if set, else the one from nodejs-wheel-binaries."""
+    override = os.environ.get("OPENPINESCRIPT_NODE")
+    if override:
+        return override
+    import nodejs_wheel
+
+    root = os.path.dirname(nodejs_wheel.__file__)
+    return os.path.join(root, "node.exe") if os.name == "nt" else os.path.join(root, "bin", "node")
+
+
+def command(args):
+    """The full argv for running the engine CLI with `args`."""
+    if not CLI_JS.is_file():
+        raise RuntimeError(f"vendored engine not found at {CLI_JS}; run scripts/vendor_engine.py")
+    return [node_executable(), str(CLI_JS), *[str(a) for a in args]]
+
+
+def engine_version():
+    return (ENGINE_DIR / "VERSION").read_text(encoding="utf-8").strip()
+

openpinescript-0.1.1.dist-info/METADATA

@@ -0,0 +1,140 @@
+Metadata-Version: 2.5
+Name: openpinescript
+Version: 0.1.1
+Summary: Run TradingView Pine Script (v1-v6) locally and offline: indicators, plots and strategy backtests. Python wrapper over the openpinescript engine, no Node install needed.
+Project-URL: Homepage, https://github.com/be-thomas/OpenPineScript-python
+Project-URL: Repository, https://github.com/be-thomas/OpenPineScript-python
+Project-URL: Documentation, https://be-thomas.github.io/OpenPineScript/
+Project-URL: Engine, https://github.com/be-thomas/OpenPineScript
+Project-URL: Issues, https://github.com/be-thomas/OpenPineScript-python/issues
+Author: be-thomas
+License-Expression: GPL-3.0-or-later
+License-File: LICENSE
+Keywords: backtesting,indicators,pine-script,pinescript,technical-analysis,trading,tradingview
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Office/Business :: Financial :: Investment
+Classifier: Topic :: Software Development :: Compilers
+Requires-Python: >=3.9
+Requires-Dist: nodejs-wheel-binaries>=20
+Provides-Extra: pandas
+Requires-Dist: pandas; extra == 'pandas'
+Description-Content-Type: text/markdown
+
+# openpinescript
+
+Run TradingView Pine Script (v1 to v6) locally and offline. It compiles your script to JavaScript and runs it on your own OHLCV candles: indicators, plots and strategy backtests, with no TradingView account and no network.
+
+This package is a thin Python wrapper over the [`openpinescript`](https://github.com/be-thomas/OpenPineScript) npm engine. Its version always matches the engine release it bundles (`openpinescript 0.1.1` bundles engine `0.1.1`; a Python-only fix is released as `0.1.1.postN`). Node.js is bundled too (through [`nodejs-wheel-binaries`](https://pypi.org/project/nodejs-wheel-binaries/)), so you do not need Node or npm installed.
+
+```
+pip install openpinescript
+pip install "openpinescript[pandas]"   # to pass pandas DataFrames
+```
+
+Requires Python 3.9 or newer. Docs for the engine, the Pine features it supports and the full CLI reference: https://be-thomas.github.io/OpenPineScript/
+
+## Command line
+
+The `openpinescript` command passes every argument to the engine CLI and gives the same stdout, stderr and exit code as `npx openpinescript`.
+
+```
+openpinescript sma_cross.pine --data sample.csv --out-dir results
+```
+
+```
+Compiling: sma_cross.pine...
+Pine Script: v5
+Running backtest: 150 bars...
+✔ Done.
+✔ Chart    → results/chart.csv
+✔ Trades   → results/trades.csv  (3 trades)
+✔ Summary  → results/summary.json
+
+=== sma_cross.pine — Summary ===
+Bars processed : 150
+Plots recorded : 2
+
+Performance:
+  Net Profit         $-279.00 (-0.28%)
+  Total Trades       3
+  Win Rate           33.3%  (1W / 2L)
+  Profit Factor      0.179
+  Max Drawdown       0.34%
+  Avg Win / Avg Loss $61.00 / $170.00
+
+Script Inputs:
+  input_0  "Fast Length"  [integer]  = 9 (default)
+  input_1  "Slow Length"  [integer]  = 21 (default)
+  Tip: override with --input input_0=<value>
+```
+
+The CSV has one bar per row, oldest first, with columns `time,open,high,low,close,volume` (ISO 8601 or `YYYY-MM-DD` times). With no `--out-*` flag the result is printed to stdout as JSON. See the [CLI guide](https://be-thomas.github.io/OpenPineScript/cli.md) for every flag.
+
+## Python
+
+```python
+import openpinescript
+
+result = openpinescript.run("sma_cross.pine", "sample.csv", inputs={"input_0": 5, "input_1": 30})
+print(result["bars_processed"])   # 150
+print(result["performance"])
+```
+
+```
+150
+{'net_profit': -1396, 'net_profit_percent': -1.4, 'gross_profit': 0, 'gross_loss': 1396, 'total_closed_trades': 3, 'winning_trades': 0, 'losing_trades': 3, 'win_rate': 0, 'avg_win': 0, 'avg_loss': 465.33, 'profit_factor': 0, 'max_drawdown_percent': 1.4}
+```
+
+`run(script, data, *, inputs=None, out_dir=None, extra_args=None, timeout=None)` returns the CLI's JSON result as a dict (`script`, `bars_processed`, `inputs`, `performance`; `performance` is `None` for an indicator).
+
+- `script` is a path to a `.pine` file, or Pine source text.
+- `data` is a CSV path or a pandas DataFrame with `time`, `open`, `high`, `low`, `close` and (optionally) `volume` columns; a `DatetimeIndex` works in place of `time`.
+- `inputs={"input_0": 5}` overrides `input()` calls (`--input input_0=5`). Booleans are sent as 1 or 0.
+- `out_dir` also writes `chart.csv`, `trades.csv` and `summary.json` there and adds a `"files"` list to the result.
+- `extra_args` are more CLI flags, and `timeout` is in seconds.
+
+```python
+import pandas as pd, openpinescript
+
+df = pd.read_csv("sample.csv", parse_dates=["time"])
+openpinescript.run('//@version=5\nindicator("x")\nplot(close)\n', df)["bars_processed"]   # 150
+```
+
+A failing run raises `OpenPineScriptError`, with `.returncode` and `.stderr`:
+
+```python
+try:
+    openpinescript.run("broken.pine", "sample.csv")
+except openpinescript.OpenPineScriptError as e:
+    print(e.returncode)   # 1
+    print(e.stderr)
+```
+
+```
+1
+Compiling: broken.pine...
+Transpilation failed: Pine Script v5: parsing failed with 1 error(s)
+  [Line 4:0] The script ends in the middle of a statement at line 3 — was it pasted completely? (missing ')' at '<EOF>')
+```
+
+`openpinescript.__version__` is the package version and `openpinescript.engine_version()` the bundled engine version.
+
+## Notes
+
+- The engine, not this wrapper, defines behaviour: `openpinescript --help` prints usage to stdout and exits 0; a missing script or `--data` prints usage to stderr and exits 1, exactly like `npx openpinescript`.
+- Set `OPENPINESCRIPT_NODE=/path/to/node` to use a different Node (20 or newer) than the bundled one.
+
+## License
+
+GPL-3.0-or-later, the same as the engine.