briskapi 0.2.0__tar.gz → 0.2.2__tar.gz

{briskapi-0.2.0 → briskapi-0.2.2}/PKG-INFO

@@ -1,9 +1,22 @@
 Metadata-Version: 2.4
 Name: briskapi
-Version: 0.2.0
+Version: 0.2.2
 Summary: Unofficial Python API, live feed and shared archive for BRiSK auction data
 License-Expression: MIT
 Project-URL: Source, https://github.com/honvl/BRiSKapi
+Project-URL: Issues, https://github.com/honvl/BRiSKapi/issues
+Project-URL: Releases, https://github.com/honvl/BRiSKapi/releases
+Project-URL: Privacy, https://github.com/honvl/BRiSKapi/blob/main/PRIVACY.md
+Keywords: brisk,market-data,auction,tokyo-stock-exchange,japan,sbi
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+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.12
+Classifier: Topic :: Office/Business :: Financial :: Investment
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
@@ -14,7 +27,7 @@ Dynamic: license-file
 
 # briskapi
 
-[English](README.md) | [日本語](README.ja.md)
+[English](https://github.com/honvl/BRiSKapi/blob/main/README.md) | [日本語](https://github.com/honvl/BRiSKapi/blob/main/README.ja.md)
 
 An unofficial, pybrisk-style Python API and `brisk` command line for BRiSK auction
 data. Consume a live feed, query recordings at any point in time, pull shared
@@ -179,7 +192,7 @@ API never asks: until you decide, sessions stay on your computer.
   alias (random `anon-…` by default) and license. Your IP address is used only to
   rate limit uploads.
 - **Visibility:** published recordings are public and permanent, and you cannot
-  delete them yourself. See [PRIVACY.md](PRIVACY.md).
+  delete them yourself. See [PRIVACY.md](https://github.com/honvl/BRiSKapi/blob/main/PRIVACY.md).
 - **Opting out:** `brisk consent --revoke`, `BRISK_CONTRIBUTE=0`, or `--no-upload`
   for one run.
 - **License:** accepting declares that you may redistribute the recordings under
@@ -190,12 +203,11 @@ API never asks: until you decide, sessions stay on your computer.
 
 ## More documentation
 
-- [ARCHITECTURE.md](ARCHITECTURE.md): how it works, data format, archive integrity and limits
-- [PRIVACY.md](PRIVACY.md): privacy policy
-- [CONTRIBUTING.md](CONTRIBUTING.md): development, tests and releases
-- [tools/brisk_mock/README.md](tools/brisk_mock/README.md): Rust collector, field definitions, timing and latency
-- [tools/brisk_mock/NAUTILUS_V2.md](tools/brisk_mock/NAUTILUS_V2.md): NautilusTrader v2 integration
-- [infra/README.md](infra/README.md): deploying your own archive
-- [THIRD_PARTY.md](THIRD_PARTY.md): decoder, data and pybrisk attribution
+- [ARCHITECTURE.md](https://github.com/honvl/BRiSKapi/blob/main/ARCHITECTURE.md): how it works, data format, archive integrity and limits
+- [PRIVACY.md](https://github.com/honvl/BRiSKapi/blob/main/PRIVACY.md): privacy policy
+- [CONTRIBUTING.md](https://github.com/honvl/BRiSKapi/blob/main/CONTRIBUTING.md): development, tests and releases
+- [tools/brisk_mock/README.md](https://github.com/honvl/BRiSKapi/blob/main/tools/brisk_mock/README.md): Rust collector, field definitions, timing and latency
+- [infra/README.md](https://github.com/honvl/BRiSKapi/blob/main/infra/README.md): deploying your own archive
+- [THIRD_PARTY.md](https://github.com/honvl/BRiSKapi/blob/main/THIRD_PARTY.md): decoder, data and pybrisk attribution
 
 Software is MIT licensed.

{briskapi-0.2.0 → briskapi-0.2.2}/README.md

@@ -1,6 +1,6 @@
 # briskapi
 
-[English](README.md) | [日本語](README.ja.md)
+[English](https://github.com/honvl/BRiSKapi/blob/main/README.md) | [日本語](https://github.com/honvl/BRiSKapi/blob/main/README.ja.md)
 
 An unofficial, pybrisk-style Python API and `brisk` command line for BRiSK auction
 data. Consume a live feed, query recordings at any point in time, pull shared
@@ -165,7 +165,7 @@ API never asks: until you decide, sessions stay on your computer.
   alias (random `anon-…` by default) and license. Your IP address is used only to
   rate limit uploads.
 - **Visibility:** published recordings are public and permanent, and you cannot
-  delete them yourself. See [PRIVACY.md](PRIVACY.md).
+  delete them yourself. See [PRIVACY.md](https://github.com/honvl/BRiSKapi/blob/main/PRIVACY.md).
 - **Opting out:** `brisk consent --revoke`, `BRISK_CONTRIBUTE=0`, or `--no-upload`
   for one run.
 - **License:** accepting declares that you may redistribute the recordings under
@@ -176,12 +176,11 @@ API never asks: until you decide, sessions stay on your computer.
 
 ## More documentation
 
-- [ARCHITECTURE.md](ARCHITECTURE.md): how it works, data format, archive integrity and limits
-- [PRIVACY.md](PRIVACY.md): privacy policy
-- [CONTRIBUTING.md](CONTRIBUTING.md): development, tests and releases
-- [tools/brisk_mock/README.md](tools/brisk_mock/README.md): Rust collector, field definitions, timing and latency
-- [tools/brisk_mock/NAUTILUS_V2.md](tools/brisk_mock/NAUTILUS_V2.md): NautilusTrader v2 integration
-- [infra/README.md](infra/README.md): deploying your own archive
-- [THIRD_PARTY.md](THIRD_PARTY.md): decoder, data and pybrisk attribution
+- [ARCHITECTURE.md](https://github.com/honvl/BRiSKapi/blob/main/ARCHITECTURE.md): how it works, data format, archive integrity and limits
+- [PRIVACY.md](https://github.com/honvl/BRiSKapi/blob/main/PRIVACY.md): privacy policy
+- [CONTRIBUTING.md](https://github.com/honvl/BRiSKapi/blob/main/CONTRIBUTING.md): development, tests and releases
+- [tools/brisk_mock/README.md](https://github.com/honvl/BRiSKapi/blob/main/tools/brisk_mock/README.md): Rust collector, field definitions, timing and latency
+- [infra/README.md](https://github.com/honvl/BRiSKapi/blob/main/infra/README.md): deploying your own archive
+- [THIRD_PARTY.md](https://github.com/honvl/BRiSKapi/blob/main/THIRD_PARTY.md): decoder, data and pybrisk attribution
 
 Software is MIT licensed.

{briskapi-0.2.0 → briskapi-0.2.2}/briskapi/__init__.py

@@ -18,7 +18,7 @@ from briskapi._live import Feed, connect as _connect, record as _record, stream
 from briskapi._market import Market, Ticker
 from briskapi._recording import JST, BriskError, NotFoundError, Recording, Table
 
-__version__ = '0.2.0'
+__version__ = '0.2.2'
 __all__ = ['JST', 'Archive', 'BriskError', 'Feed', 'Market', 'NotFoundError', 'Recording', 'Table', 'Ticker',
            'connect', 'consent', 'current', 'load', 'pull', 'record', 'recordings', 'stream']
 

{briskapi-0.2.0 → briskapi-0.2.2}/briskapi/_live.py

@@ -45,6 +45,7 @@ def _stop(process):
 
 def stream(web=False, cache=None, codes=None, speed=1, limit_frames=None, node='node') -> Iterator[dict]:
     """Yield raw decoded batches as each frame replays (bootstrap, quote deltas, end)."""
+    cli.check_node(node)
     process = _decoder(web, cache, codes, speed, limit_frames, node)
     try:
         for line in process.stdout:
@@ -90,6 +91,7 @@ class Feed:
                  history=False, node='node', *, command=None, env=None, timing=None):
         # `command` runs another decoder host (SBI live). Its market data is never
         # contributed; with `timing` set, a timing-only summary may be.
+        cli.check_node(command[0] if command else node)
         if command is None:
             choice, upload = _consent(contribute, limit_frames)
             self._choice, self._timing = (choice if upload else None), None

{briskapi-0.2.0 → briskapi-0.2.2}/briskapi/cli.py

@@ -20,12 +20,14 @@ import warnings
 import boto3
 from botocore import UNSIGNED
 from botocore.config import Config
+from briskapi._recording import BriskError
 from briskapi.schema import (SCHEMA, MAX_TIMING_BYTES, canonical_lines, compress, digest, inspect_package, validate_manifest,
                              validate_stream, validate_timing, require)
 
 PACKAGE = Path(__file__).resolve().parent
 # BRiSK's own WASM decoder runs under Node; the package ships only this host and SHA-256 pins.
 DECODER = PACKAGE / 'decoder' / 'decoder.cjs'
+MIN_NODE = 22
 LICENSES = ('CC0-1.0', 'CC-BY-4.0')
 # Bump with any PRIVACY.md change to what is collected; saved choices then lapse.
 POLICY_VERSION = 2
@@ -46,6 +48,20 @@ Policy: https://github.com/honvl/BRiSKapi/blob/main/PRIVACY.md
 Opt out at any time: `brisk consent --revoke` or BRISK_CONTRIBUTE=0.
 '''
 
+def check_node(node='node'):
+    """Fail early, with the fix, when Node is missing or older than the decoder hosts support."""
+    advice = f'Install Node.js {MIN_NODE} or newer from https://nodejs.org, or pass the path to it.'
+    try:
+        out = subprocess.run([node, '--version'], capture_output=True, text=True, timeout=30).stdout
+    except FileNotFoundError:
+        raise BriskError(f'Node.js was not found (looked for {str(node)!r}). BRiSK\'s decoder runs under Node. {advice}') from None
+    except (OSError, subprocess.SubprocessError) as error:
+        raise BriskError(f'Could not run {str(node)!r} --version: {error}. {advice}') from error
+    found = re.match(r'v(\d+)\.', out.strip())
+    if found and int(found[1]) < MIN_NODE:
+        raise BriskError(f'Node.js {out.strip()} is too old; the decoder hosts need Node {MIN_NODE}+. {advice}')
+
+
 def settings(path=None):
     return json.loads((path or PACKAGE / 'archive.json').read_text())
 
@@ -211,6 +227,7 @@ def record_events(events, web=False, cache=None, codes=None, limit_frames=None,
     Needs only Node. A Rust collector binary (`brisk_quote_ingest`) is optional; it
     records the same batches and adds its own state validation and latency display.
     """
+    check_node(node)
     options = ['--web'] if web else ['--cache', str(cache)]
     options += ['--speed', str(speed)]
     if codes:
@@ -250,7 +267,16 @@ def live(args):
         print(json.dumps({'contribution': feed.contribution}), file=sys.stderr)
 
 def main(argv=None):
-    parser = argparse.ArgumentParser(description=__doc__)
+    try:
+        _main(argv)
+    except BriskError as error:
+        sys.exit(f'brisk: error: {error}')
+
+
+def _main(argv):
+    from briskapi import __version__
+    parser = argparse.ArgumentParser(prog='brisk', description=__doc__)
+    parser.add_argument('--version', action='version', version=f'%(prog)s {__version__}')
     parser.add_argument('--config', type=Path, default=PACKAGE / 'archive.json')
     sub = parser.add_subparsers(dest='command', required=True)
     for name in ('record', 'package'):

{briskapi-0.2.0 → briskapi-0.2.2}/briskapi.egg-info/PKG-INFO

@@ -1,9 +1,22 @@
 Metadata-Version: 2.4
 Name: briskapi
-Version: 0.2.0
+Version: 0.2.2
 Summary: Unofficial Python API, live feed and shared archive for BRiSK auction data
 License-Expression: MIT
 Project-URL: Source, https://github.com/honvl/BRiSKapi
+Project-URL: Issues, https://github.com/honvl/BRiSKapi/issues
+Project-URL: Releases, https://github.com/honvl/BRiSKapi/releases
+Project-URL: Privacy, https://github.com/honvl/BRiSKapi/blob/main/PRIVACY.md
+Keywords: brisk,market-data,auction,tokyo-stock-exchange,japan,sbi
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+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.12
+Classifier: Topic :: Office/Business :: Financial :: Investment
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
@@ -14,7 +27,7 @@ Dynamic: license-file
 
 # briskapi
 
-[English](README.md) | [日本語](README.ja.md)
+[English](https://github.com/honvl/BRiSKapi/blob/main/README.md) | [日本語](https://github.com/honvl/BRiSKapi/blob/main/README.ja.md)
 
 An unofficial, pybrisk-style Python API and `brisk` command line for BRiSK auction
 data. Consume a live feed, query recordings at any point in time, pull shared
@@ -179,7 +192,7 @@ API never asks: until you decide, sessions stay on your computer.
   alias (random `anon-…` by default) and license. Your IP address is used only to
   rate limit uploads.
 - **Visibility:** published recordings are public and permanent, and you cannot
-  delete them yourself. See [PRIVACY.md](PRIVACY.md).
+  delete them yourself. See [PRIVACY.md](https://github.com/honvl/BRiSKapi/blob/main/PRIVACY.md).
 - **Opting out:** `brisk consent --revoke`, `BRISK_CONTRIBUTE=0`, or `--no-upload`
   for one run.
 - **License:** accepting declares that you may redistribute the recordings under
@@ -190,12 +203,11 @@ API never asks: until you decide, sessions stay on your computer.
 
 ## More documentation
 
-- [ARCHITECTURE.md](ARCHITECTURE.md): how it works, data format, archive integrity and limits
-- [PRIVACY.md](PRIVACY.md): privacy policy
-- [CONTRIBUTING.md](CONTRIBUTING.md): development, tests and releases
-- [tools/brisk_mock/README.md](tools/brisk_mock/README.md): Rust collector, field definitions, timing and latency
-- [tools/brisk_mock/NAUTILUS_V2.md](tools/brisk_mock/NAUTILUS_V2.md): NautilusTrader v2 integration
-- [infra/README.md](infra/README.md): deploying your own archive
-- [THIRD_PARTY.md](THIRD_PARTY.md): decoder, data and pybrisk attribution
+- [ARCHITECTURE.md](https://github.com/honvl/BRiSKapi/blob/main/ARCHITECTURE.md): how it works, data format, archive integrity and limits
+- [PRIVACY.md](https://github.com/honvl/BRiSKapi/blob/main/PRIVACY.md): privacy policy
+- [CONTRIBUTING.md](https://github.com/honvl/BRiSKapi/blob/main/CONTRIBUTING.md): development, tests and releases
+- [tools/brisk_mock/README.md](https://github.com/honvl/BRiSKapi/blob/main/tools/brisk_mock/README.md): Rust collector, field definitions, timing and latency
+- [infra/README.md](https://github.com/honvl/BRiSKapi/blob/main/infra/README.md): deploying your own archive
+- [THIRD_PARTY.md](https://github.com/honvl/BRiSKapi/blob/main/THIRD_PARTY.md): decoder, data and pybrisk attribution
 
 Software is MIT licensed.

{briskapi-0.2.0 → briskapi-0.2.2}/briskapi.egg-info/SOURCES.txt

@@ -26,5 +26,6 @@ briskapi/decoder/web.cjs
 briskapi/references/historical_mock.json
 tests/test_api.py
 tests/test_archive.py
+tests/test_package.py
 tests/test_sbi.py
 tests/test_timing.py

{briskapi-0.2.0 → briskapi-0.2.2}/pyproject.toml

@@ -4,18 +4,33 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "briskapi"
-version = "0.2.0"
+version = "0.2.2"
 description = "Unofficial Python API, live feed and shared archive for BRiSK auction data"
 readme = "README.md"
 license = "MIT"
 requires-python = ">=3.12"
 dependencies = ["boto3>=1.41,<2"]
+keywords = ["brisk", "market-data", "auction", "tokyo-stock-exchange", "japan", "sbi"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Financial and Insurance Industry",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Office/Business :: Financial :: Investment",
+]
 
 [project.optional-dependencies]
 pandas = ["pandas>=2"]
 
 [project.urls]
 Source = "https://github.com/honvl/BRiSKapi"
+Issues = "https://github.com/honvl/BRiSKapi/issues"
+Releases = "https://github.com/honvl/BRiSKapi/releases"
+Privacy = "https://github.com/honvl/BRiSKapi/blob/main/PRIVACY.md"
 
 [project.scripts]
 brisk = "briskapi.cli:main"

{briskapi-0.2.0 → briskapi-0.2.2}/tests/test_archive.py

@@ -448,6 +448,7 @@ def harness(tmp_path, monkeypatch):
         else:
             Path(cmd[cmd.index('--events') + 1]).write_bytes(raw(batches()))
     monkeypatch.setattr(cli.subprocess, 'run', run)
+    monkeypatch.setattr(cli, 'check_node', lambda node='node': None)
     (tmp_path / 'source.jsonl').write_bytes(raw(batches()))
     def main(*args):
         cli.main(['--config', str(config), *args])
@@ -529,6 +530,7 @@ def test_consent_controls(tmp_path, monkeypatch, harness, capsys):
 def test_record_events_command(monkeypatch, tmp_path):
     calls = []
     monkeypatch.setattr(cli.subprocess, 'run', lambda cmd, check, stdout=None: calls.append((cmd, stdout)))
+    monkeypatch.setattr(cli, 'check_node', lambda node='node': None)
     cli.record_events(tmp_path / 'e.jsonl', cache=tmp_path, codes=['7203', '6758'], limit_frames=5, speed=0)
     cmd, stdout = calls[0]
     assert cmd[:2] == ['node', str(cli.DECODER)] and stdout is not None and cli.DECODER.exists()

briskapi-0.2.2/tests/test_package.py

@@ -0,0 +1,92 @@
+"""Install-time behavior: the Node preflight, --version and the PyPI package description."""
+import re
+import subprocess
+import tomllib
+from pathlib import Path
+
+import pytest
+
+import briskapi
+import briskapi.cli as cli
+from briskapi import _live, sbi
+
+ROOT = Path(__file__).resolve().parent.parent
+
+
+@pytest.fixture(autouse=True)
+def isolated(tmp_path, monkeypatch):
+    monkeypatch.setenv('XDG_CONFIG_HOME', str(tmp_path / 'config'))
+    monkeypatch.delenv('BRISK_CONTRIBUTE', raising=False)
+    monkeypatch.setattr(briskapi, '_current', None)
+
+
+def fake_node(tmp_path, output, executable=True):
+    script = tmp_path / 'fake-node'
+    script.write_text(f'#!/bin/sh\necho {output}\n')
+    script.chmod(0o755 if executable else 0o644)
+    return str(script)
+
+
+def test_check_node_accepts_supported_versions(tmp_path):
+    for output in ('v22.0.0', 'v25.2.1', 'unrecognised output'):
+        cli.check_node(fake_node(tmp_path, output))
+    cli.check_node()  # The real node on PATH, as the other tests need.
+
+
+def test_check_node_explains_how_to_fix_it(tmp_path):
+    with pytest.raises(briskapi.BriskError, match=r'Node\.js was not found.*nodejs\.org'):
+        cli.check_node(str(tmp_path / 'missing'))
+    with pytest.raises(briskapi.BriskError, match=r'v20\.11\.0 is too old.*Node 22\+.*nodejs\.org'):
+        cli.check_node(fake_node(tmp_path, 'v20.11.0'))
+    with pytest.raises(briskapi.BriskError, match=r'Could not run.*nodejs\.org'):
+        cli.check_node(fake_node(tmp_path, 'v22.0.0', executable=False))
+
+
+def test_check_node_reports_a_hung_node(monkeypatch):
+    def hang(*args, **kwargs):
+        raise subprocess.TimeoutExpired('node', 30)
+
+    monkeypatch.setattr(cli.subprocess, 'run', hang)
+    with pytest.raises(briskapi.BriskError, match='Could not run'):
+        cli.check_node()
+
+
+def test_every_entry_point_checks_node_first(tmp_path):
+    missing = str(tmp_path / 'missing')
+    with pytest.raises(briskapi.BriskError, match='not found'):
+        next(_live.stream(cache=tmp_path, node=missing))
+    with pytest.raises(briskapi.BriskError, match='not found'):
+        briskapi.Feed(cache=tmp_path, node=missing)
+    with pytest.raises(briskapi.BriskError, match='not found'):
+        briskapi.connect(cache=tmp_path, node=missing)
+    with pytest.raises(briskapi.BriskError, match='not found'):
+        cli.record_events(tmp_path / 'events.jsonl', cache=tmp_path, node=missing)
+    sbi.login({'session_bfaf77a2': 'v'})
+    with pytest.raises(briskapi.BriskError, match='not found'):
+        sbi.connect(node=missing)
+    assert briskapi._current is None
+
+
+def test_cli_reports_errors_without_a_traceback(tmp_path, monkeypatch):
+    monkeypatch.setenv('PATH', str(tmp_path))
+    with pytest.raises(SystemExit) as stopped:
+        cli.main(['live', '--cache', str(tmp_path)])
+    assert str(stopped.value.code).startswith('brisk: error: Node.js was not found')
+
+
+def test_cli_version(capsys):
+    with pytest.raises(SystemExit) as stopped:
+        cli.main(['--version'])
+    assert stopped.value.code == 0
+    assert capsys.readouterr().out.strip() == f'brisk {briskapi.__version__}'
+
+
+def test_version_matches_pyproject():
+    project = tomllib.loads((ROOT / 'pyproject.toml').read_text())['project']
+    assert project['version'] == briskapi.__version__
+
+
+def test_readme_links_work_on_pypi():
+    # README.md is the PyPI description, where relative links do not resolve.
+    readme = (ROOT / 'README.md').read_text()
+    assert not re.findall(r'\]\((?!https?://|#|mailto:)[^)]+\)', readme)