briskapi 0.2.0__tar.gz

briskapi-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 honvl
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

briskapi-0.2.0/PKG-INFO

@@ -0,0 +1,201 @@
+Metadata-Version: 2.4
+Name: briskapi
+Version: 0.2.0
+Summary: Unofficial Python API, live feed and shared archive for BRiSK auction data
+License-Expression: MIT
+Project-URL: Source, https://github.com/honvl/BRiSKapi
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: boto3<2,>=1.41
+Provides-Extra: pandas
+Requires-Dist: pandas>=2; extra == "pandas"
+Dynamic: license-file
+
+# briskapi
+
+[English](README.md) | [日本語](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
+recordings from a public archive, and use SBI BRiSK with your own account. This
+is an independent project, not affiliated with or endorsed by BRiSK, Tachibana,
+SBI, TSE or JPX.
+
+> **Data sources:**
+> - **No account needed:** the public BRiSK Next demo of 27 September 2021 (one
+>   pre-open snapshot and the first three minutes after the open), replayed at
+>   its recorded pace. This is not live market data.
+> - **With an SBI Securities BRiSK subscription:** SBI BRiSK market data (candles,
+>   margin, alerts, schedule, watchlist) and an experimental live feed.
+
+## Install
+
+Python 3.12+. Live feeds and recording also need Node 22+, because BRiSK's own
+decoder is a WebAssembly module that runs under Node.
+
+```sh
+pip install 'briskapi[pandas]'      # `import briskapi` and the `brisk` command
+```
+
+BRiSK's decoder and demo data are downloaded at runtime; the package doesn't
+include them. Optional prebuilt Rust tools (`brisk_quote_ingest`,
+`brisk_recording`) for Linux, macOS and Windows are attached to each
+[GitHub release](https://github.com/honvl/BRiSKapi/releases). To work from source,
+clone the repository and run `pip install -e '.[pandas]'`.
+
+## Live feed
+
+```python
+import briskapi
+
+feed = briskapi.connect(web=True, codes=["7203", "6758"])   # returns once initial state is in
+toyota = briskapi.Ticker("7203")
+toyota.quote()        # current quote, updated as each frame arrives
+toyota.auction()      # indicative price/volume and market-order imbalance
+
+feed.on_quote(lambda q: print(q["code"], q["indicative_price"]), codes="6758")
+for q in feed.quotes("7203"):       # one item per update; ends with the session
+    if q["last_price"]:
+        print("opened at", q["last_price"], q["time"])
+        break
+
+briskapi.Market().imbalances(top=10).to_pandas()
+feed.wait()           # or feed.close(); `with briskapi.connect(...) as feed:` also works
+```
+
+Options: `web=True` (fetch from the demo site) or `cache=DIR` (a local copy of
+the demo assets), `codes`, `speed` (`1` real time, `0` as fast as possible) and
+`history=True` (keep updates for `Ticker.history()`). Callbacks and iterators
+first receive each security's current quote, then every update in order. A slow
+consumer slows the feed instead of losing updates.
+
+## Recordings and the archive
+
+```python
+briskapi.recordings(source="historical_mock")   # published recordings; no AWS account needed
+briskapi.pull("archive/20210927/SHA256")       # download, verify, decode and cache; becomes the default
+briskapi.load("recordings/my-session")         # or a local recording (events.jsonl[.gz] or folder)
+briskapi.record("recordings/my-session", web=True)   # record the demo yourself
+
+briskapi.Ticker("7203").quote(at="08:59:59.99")               # state at any JST time
+briskapi.Ticker("7203").history(start="09:00", end="09:01")   # every update in a window
+briskapi.Market().snapshot(at="09:00:00").to_pandas()
+```
+
+## SBI BRiSK
+
+For SBI Securities customers with a BRiSK subscription. Log in on
+[sbi.brisk.jp](https://sbi.brisk.jp) in your browser, then pass its session
+cookies: copy them from DevTools, or use `pycookiecheat`'s
+`chrome_cookies("https://sbi.brisk.jp")`.
+
+```python
+from briskapi import sbi
+
+sbi.login(cookies={"session_bfaf77a2": "v2.local..."})   # remember=True saves them (owner-only file)
+toyota = briskapi.Ticker("7203")
+toyota.candles("5m").to_pandas()   # price bars: 5m (today), 1d, 1w or 1mo
+toyota.margin(days=30)             # margin balances and stock-lending fees
+market = briskapi.Market()
+market.turnover()     # turnover and shares outstanding, all stocks
+market.lists()        # NK225, recent IPOs, …
+market.events()       # basket orders, limit up/down, volume surges
+market.schedule()     # trading date, status and session times
+market.watchlist()    # your saved codes
+
+feed = sbi.connect(codes=["7203"])          # live (experimental)
+toyota.quote()                              # same calls as any feed
+```
+
+Results use the conventions below. Errors are `sbi.SessionExpiredError` (log in
+again), `briskapi.NotFoundError`, `sbi.RateLimitError` and `sbi.APIError`.
+Requests are limited to one per second.
+
+The live feed runs SBI's own decoder under Node, downloaded with your session;
+no browser is involved. It hasn't yet been validated against a live SBI session,
+so it fails with an explicit error rather than guessing. Please report what you
+see. Your cookies go only to sbi.brisk.jp, and SBI market data never leaves
+your computer. With sharing on, a session contributes only a timing summary (see
+below).
+
+## API reference
+
+| Call | Returns |
+| --- | --- |
+| `briskapi.connect(...)` | Live `Feed`; becomes the default source |
+| `Ticker(code).info()` | Name, lot size, tick type, base price and daily limits |
+| `Ticker(code).quote(at=None)` | Bid/ask, indicative price/volume, market-order and closing quantities, last trade |
+| `Ticker(code).auction(at=None)` | Indicative auction state with `market_order_imbalance` (market buy minus sell) |
+| `Ticker(code).history(start, end)` | Every update in order |
+| `Market().stocks()` | Master for every security |
+| `Market().snapshot(at=None)` | Every security's quote |
+| `Market().imbalances(at=None, top=None)` | Securities ranked by absolute market-order imbalance |
+| `Market().summary()` | Source, date, coverage and clock range |
+| `Feed.quotes(codes)` / `Feed.on_quote(fn, codes)` | Live updates as they arrive |
+| `briskapi.recordings()` / `.pull()` / `.load()` | Archive listing, verified download, local file |
+| `briskapi.record(output, web=True, ...)` | A recording of the demo, shared per your choice |
+| `briskapi.consent(...)` | Your sharing choice |
+| `Ticker(code).candles(interval)` / `.margin(days)` | SBI BRiSK price bars; margin balances and lending fees |
+| `Market().turnover()` / `.lists()` / `.events()` / `.schedule()` / `.watchlist()` | SBI BRiSK market data |
+| `briskapi.sbi.login()` / `.connect()` | SBI BRiSK session and live feed |
+
+Prices are yen floats, with `None` for the vendor's zero "unavailable" value.
+Times are JST `datetime`s on the trading date. Quantities are shares; side, flag
+and status codes are raw vendor values. `raw=True` returns vendor fields
+(`*_price10` in tenths of a yen, `*_us` in microseconds since JST midnight).
+Tabular results are lists of dicts with `.to_pandas()`. Errors are
+`briskapi.BriskError` and `briskapi.NotFoundError`. A whole-market query reads a
+recording once (about six seconds for the complete 420 MB demo).
+
+## Command line
+
+```sh
+brisk live --web --codes 7203,6758          # one JSON object per quote update (--raw for vendor fields)
+brisk live --sbi --codes 7203               # SBI BRiSK; cookies from BRISK_SBI_COOKIES (JSON)
+brisk record --web --output recordings/s1   # record a replay (shared if you agreed)
+brisk list --date 20210927 --source historical_mock
+brisk pull archive/20210927/SHA256 --output recordings/downloaded
+brisk consent [--accept | --revoke]         # show or change sharing
+brisk upload recordings/s1                  # retry sharing a recording
+```
+
+Each command has `--help`. `pull` verifies everything before writing and never
+overwrites an existing folder.
+
+## Sharing recordings
+
+The first time you record or start a demo live session from the command line,
+the tool shows what would be shared and asks once; Enter accepts. After that,
+every complete demo session is uploaded and published automatically. The Python
+API never asks: until you decide, sessions stay on your computer.
+
+- **SBI sessions share timing only:** percentiles of decode time, data age at
+  receipt and frame spacing, a stall count, the frame count, the trading date,
+  the first and last minute, and your alias and license. Never prices,
+  quantities or codes. `briskapi.Archive().timing()` lists everyone's reports.
+- **What a demo session shares:** the market data you recorded, local timing measurements
+  (including your computer's clock, which shows when you recorded), and a public
+  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).
+- **Opting out:** `brisk consent --revoke`, `BRISK_CONTRIBUTE=0`, or `--no-upload`
+  for one run.
+- **License:** accepting declares that you may redistribute the recordings under
+  the chosen data license (CC0-1.0 or CC-BY-4.0). This project's open-source
+  license gives no rights to vendor or exchange data. If you can't make that
+  declaration, turn sharing off.
+- Partial replays (`--limit-frames`) and sessions closed early are never shared.
+
+## 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
+
+Software is MIT licensed.

briskapi-0.2.0/README.md

@@ -0,0 +1,187 @@
+# briskapi
+
+[English](README.md) | [日本語](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
+recordings from a public archive, and use SBI BRiSK with your own account. This
+is an independent project, not affiliated with or endorsed by BRiSK, Tachibana,
+SBI, TSE or JPX.
+
+> **Data sources:**
+> - **No account needed:** the public BRiSK Next demo of 27 September 2021 (one
+>   pre-open snapshot and the first three minutes after the open), replayed at
+>   its recorded pace. This is not live market data.
+> - **With an SBI Securities BRiSK subscription:** SBI BRiSK market data (candles,
+>   margin, alerts, schedule, watchlist) and an experimental live feed.
+
+## Install
+
+Python 3.12+. Live feeds and recording also need Node 22+, because BRiSK's own
+decoder is a WebAssembly module that runs under Node.
+
+```sh
+pip install 'briskapi[pandas]'      # `import briskapi` and the `brisk` command
+```
+
+BRiSK's decoder and demo data are downloaded at runtime; the package doesn't
+include them. Optional prebuilt Rust tools (`brisk_quote_ingest`,
+`brisk_recording`) for Linux, macOS and Windows are attached to each
+[GitHub release](https://github.com/honvl/BRiSKapi/releases). To work from source,
+clone the repository and run `pip install -e '.[pandas]'`.
+
+## Live feed
+
+```python
+import briskapi
+
+feed = briskapi.connect(web=True, codes=["7203", "6758"])   # returns once initial state is in
+toyota = briskapi.Ticker("7203")
+toyota.quote()        # current quote, updated as each frame arrives
+toyota.auction()      # indicative price/volume and market-order imbalance
+
+feed.on_quote(lambda q: print(q["code"], q["indicative_price"]), codes="6758")
+for q in feed.quotes("7203"):       # one item per update; ends with the session
+    if q["last_price"]:
+        print("opened at", q["last_price"], q["time"])
+        break
+
+briskapi.Market().imbalances(top=10).to_pandas()
+feed.wait()           # or feed.close(); `with briskapi.connect(...) as feed:` also works
+```
+
+Options: `web=True` (fetch from the demo site) or `cache=DIR` (a local copy of
+the demo assets), `codes`, `speed` (`1` real time, `0` as fast as possible) and
+`history=True` (keep updates for `Ticker.history()`). Callbacks and iterators
+first receive each security's current quote, then every update in order. A slow
+consumer slows the feed instead of losing updates.
+
+## Recordings and the archive
+
+```python
+briskapi.recordings(source="historical_mock")   # published recordings; no AWS account needed
+briskapi.pull("archive/20210927/SHA256")       # download, verify, decode and cache; becomes the default
+briskapi.load("recordings/my-session")         # or a local recording (events.jsonl[.gz] or folder)
+briskapi.record("recordings/my-session", web=True)   # record the demo yourself
+
+briskapi.Ticker("7203").quote(at="08:59:59.99")               # state at any JST time
+briskapi.Ticker("7203").history(start="09:00", end="09:01")   # every update in a window
+briskapi.Market().snapshot(at="09:00:00").to_pandas()
+```
+
+## SBI BRiSK
+
+For SBI Securities customers with a BRiSK subscription. Log in on
+[sbi.brisk.jp](https://sbi.brisk.jp) in your browser, then pass its session
+cookies: copy them from DevTools, or use `pycookiecheat`'s
+`chrome_cookies("https://sbi.brisk.jp")`.
+
+```python
+from briskapi import sbi
+
+sbi.login(cookies={"session_bfaf77a2": "v2.local..."})   # remember=True saves them (owner-only file)
+toyota = briskapi.Ticker("7203")
+toyota.candles("5m").to_pandas()   # price bars: 5m (today), 1d, 1w or 1mo
+toyota.margin(days=30)             # margin balances and stock-lending fees
+market = briskapi.Market()
+market.turnover()     # turnover and shares outstanding, all stocks
+market.lists()        # NK225, recent IPOs, …
+market.events()       # basket orders, limit up/down, volume surges
+market.schedule()     # trading date, status and session times
+market.watchlist()    # your saved codes
+
+feed = sbi.connect(codes=["7203"])          # live (experimental)
+toyota.quote()                              # same calls as any feed
+```
+
+Results use the conventions below. Errors are `sbi.SessionExpiredError` (log in
+again), `briskapi.NotFoundError`, `sbi.RateLimitError` and `sbi.APIError`.
+Requests are limited to one per second.
+
+The live feed runs SBI's own decoder under Node, downloaded with your session;
+no browser is involved. It hasn't yet been validated against a live SBI session,
+so it fails with an explicit error rather than guessing. Please report what you
+see. Your cookies go only to sbi.brisk.jp, and SBI market data never leaves
+your computer. With sharing on, a session contributes only a timing summary (see
+below).
+
+## API reference
+
+| Call | Returns |
+| --- | --- |
+| `briskapi.connect(...)` | Live `Feed`; becomes the default source |
+| `Ticker(code).info()` | Name, lot size, tick type, base price and daily limits |
+| `Ticker(code).quote(at=None)` | Bid/ask, indicative price/volume, market-order and closing quantities, last trade |
+| `Ticker(code).auction(at=None)` | Indicative auction state with `market_order_imbalance` (market buy minus sell) |
+| `Ticker(code).history(start, end)` | Every update in order |
+| `Market().stocks()` | Master for every security |
+| `Market().snapshot(at=None)` | Every security's quote |
+| `Market().imbalances(at=None, top=None)` | Securities ranked by absolute market-order imbalance |
+| `Market().summary()` | Source, date, coverage and clock range |
+| `Feed.quotes(codes)` / `Feed.on_quote(fn, codes)` | Live updates as they arrive |
+| `briskapi.recordings()` / `.pull()` / `.load()` | Archive listing, verified download, local file |
+| `briskapi.record(output, web=True, ...)` | A recording of the demo, shared per your choice |
+| `briskapi.consent(...)` | Your sharing choice |
+| `Ticker(code).candles(interval)` / `.margin(days)` | SBI BRiSK price bars; margin balances and lending fees |
+| `Market().turnover()` / `.lists()` / `.events()` / `.schedule()` / `.watchlist()` | SBI BRiSK market data |
+| `briskapi.sbi.login()` / `.connect()` | SBI BRiSK session and live feed |
+
+Prices are yen floats, with `None` for the vendor's zero "unavailable" value.
+Times are JST `datetime`s on the trading date. Quantities are shares; side, flag
+and status codes are raw vendor values. `raw=True` returns vendor fields
+(`*_price10` in tenths of a yen, `*_us` in microseconds since JST midnight).
+Tabular results are lists of dicts with `.to_pandas()`. Errors are
+`briskapi.BriskError` and `briskapi.NotFoundError`. A whole-market query reads a
+recording once (about six seconds for the complete 420 MB demo).
+
+## Command line
+
+```sh
+brisk live --web --codes 7203,6758          # one JSON object per quote update (--raw for vendor fields)
+brisk live --sbi --codes 7203               # SBI BRiSK; cookies from BRISK_SBI_COOKIES (JSON)
+brisk record --web --output recordings/s1   # record a replay (shared if you agreed)
+brisk list --date 20210927 --source historical_mock
+brisk pull archive/20210927/SHA256 --output recordings/downloaded
+brisk consent [--accept | --revoke]         # show or change sharing
+brisk upload recordings/s1                  # retry sharing a recording
+```
+
+Each command has `--help`. `pull` verifies everything before writing and never
+overwrites an existing folder.
+
+## Sharing recordings
+
+The first time you record or start a demo live session from the command line,
+the tool shows what would be shared and asks once; Enter accepts. After that,
+every complete demo session is uploaded and published automatically. The Python
+API never asks: until you decide, sessions stay on your computer.
+
+- **SBI sessions share timing only:** percentiles of decode time, data age at
+  receipt and frame spacing, a stall count, the frame count, the trading date,
+  the first and last minute, and your alias and license. Never prices,
+  quantities or codes. `briskapi.Archive().timing()` lists everyone's reports.
+- **What a demo session shares:** the market data you recorded, local timing measurements
+  (including your computer's clock, which shows when you recorded), and a public
+  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).
+- **Opting out:** `brisk consent --revoke`, `BRISK_CONTRIBUTE=0`, or `--no-upload`
+  for one run.
+- **License:** accepting declares that you may redistribute the recordings under
+  the chosen data license (CC0-1.0 or CC-BY-4.0). This project's open-source
+  license gives no rights to vendor or exchange data. If you can't make that
+  declaration, turn sharing off.
+- Partial replays (`--limit-frames`) and sessions closed early are never shared.
+
+## 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
+
+Software is MIT licensed.

briskapi-0.2.0/briskapi/LICENSE-pybrisk.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 obichan117
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

briskapi-0.2.0/briskapi/__init__.py

@@ -0,0 +1,67 @@
+"""Python API for BRiSK auction data: recordings, the shared archive and the public demo.
+
+    import briskapi
+
+    feed = briskapi.connect(web=True)          # live: state updates as frames arrive
+    briskapi.Ticker("7203").quote()            # current auction quote
+    for q in feed.quotes("7203"): ...          # or feed.on_quote(callback)
+
+    briskapi.pull(prefix)                      # or briskapi.load(path) / briskapi.record(...)
+    briskapi.Ticker("7203").quote(at="08:59:59")
+    briskapi.Market().imbalances(top=10).to_pandas()
+"""
+from __future__ import annotations
+
+from briskapi import cli as _cli
+from briskapi._archive import Archive
+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'
+__all__ = ['JST', 'Archive', 'BriskError', 'Feed', 'Market', 'NotFoundError', 'Recording', 'Table', 'Ticker',
+           'connect', 'consent', 'current', 'load', 'pull', 'record', 'recordings', 'stream']
+
+_current: Recording | Feed | None = None
+
+
+def load(source) -> Recording | Feed:
+    """Use a live Feed or a recording (path, directory or Recording) as the default for Ticker and Market."""
+    global _current
+    _current = source if isinstance(source, (Recording, Feed)) else Recording(source)
+    return _current
+
+
+def current() -> Recording | Feed:
+    if _current is None:
+        raise BriskError('Nothing loaded: use briskapi.connect(...), briskapi.load(path), briskapi.pull(prefix) or briskapi.record(...)')
+    return _current
+
+
+def connect(**options) -> Feed:
+    """Start a live feed (see Feed) and make it the default for Ticker and Market."""
+    return load(_connect(**options))
+
+
+def recordings(date=None, source=None) -> Table:
+    """Published archive recordings (see Archive.recordings)."""
+    return Archive().recordings(date, source)
+
+
+def pull(prefix, output=None) -> Recording:
+    """Download and verify an archive recording, then make it the default."""
+    return load(Archive().pull(prefix, output))
+
+
+def record(output, **options) -> Recording:
+    """Record the public demo (see briskapi._live.record), contribute per consent and make it the default."""
+    return load(_record(output, **options))
+
+
+def consent(accept=False, revoke=False, contributor=None, license=None) -> dict | None:
+    """Show (no arguments), accept or revoke automatic contribution. See PRIVACY.md."""
+    if accept and revoke:
+        raise ValueError('Choose accept or revoke')
+    if accept:
+        return _cli.save_consent(True, contributor, license)
+    return _cli.save_consent(False) if revoke else _cli.load_consent()

briskapi-0.2.0/briskapi/__main__.py

@@ -0,0 +1,3 @@
+from briskapi.cli import main
+
+main()

briskapi-0.2.0/briskapi/_archive.py

@@ -0,0 +1,62 @@
+"""The shared public archive: list, pull (verified and cached) and contribute."""
+from __future__ import annotations
+
+import os
+from pathlib import Path
+import re
+
+from briskapi import cli
+from briskapi._recording import Recording, Table
+
+
+def cache_dir() -> Path:
+    return Path(os.environ.get('XDG_CACHE_HOME') or Path.home() / '.cache') / 'brisk'
+
+
+class Archive:
+    """Recordings published in the Tokyo archive. Reading needs no AWS account.
+
+        archive = Archive()
+        rows = archive.recordings(source="historical_mock")
+        rec = archive.pull(rows[0]["prefix"])
+    """
+
+    def __init__(self, config=None, s3=None):
+        self.config = cli.settings(Path(config) if config else None)
+        self._s3 = s3
+
+    @property
+    def s3(self):
+        if self._s3 is None:
+            self._s3 = cli.client(self.config)
+        return self._s3
+
+    def recordings(self, date=None, source=None) -> Table:
+        """Published recordings, optionally filtered by YYYYMMDD trading date and source."""
+        rows = []
+        for prefix, m in cli.manifests(self.s3, self.config['bucket'], date):
+            s = m['summary']
+            if source is None or s['source'] == source:
+                rows.append({'prefix': prefix, 'source': s['source'], 'trading_date': s['trading_date'],
+                             'securities': len(s['codes']), 'batches': s['batches'],
+                             'quote_updates': s['quote_updates'], 'bytes': m['bytes'],
+                             'contributor': m['contributor'], 'license': m['license'], 'sha256': m['sha256']})
+        return Table(rows)
+
+    def timing(self, date=None) -> Table:
+        """Published timing-only reports (from SBI BRiSK sessions), optionally for one YYYYMMDD date."""
+        return Table({'key': key, **report} for key, report in cli.timing_reports(self.s3, self.config['bucket'], date))
+
+    def pull(self, prefix, output=None) -> Recording:
+        """Download, verify and decode one recording. Without `output`, downloads are cached."""
+        if not re.fullmatch(r'archive/\d{8}/[0-9a-f]{64}', prefix):
+            raise ValueError('Invalid archive prefix')
+        target = Path(output) if output else cache_dir() / prefix
+        # Cache entries only appear after verification (pull moves them atomically).
+        if output or not target.exists():
+            cli.pull(self.s3, self.config['bucket'], prefix, target)
+        return Recording(target)
+
+    def contribute(self, directory, timeout=660) -> dict:
+        """Upload a prepared package and wait for automatic validation and publication."""
+        return cli.contribute(Path(directory), self.config['api_url'], timeout)