Command-Line Interface¶

The ob-analytics command is registered as a console entry point when the package is installed. It provides subcommands for processing data, generating galleries, and running demo pipelines.

ob-analytics process orders.csv -o results/
ob-analytics gallery results/parquet/ -o my_gallery/
ob-analytics bitstamp-demo orders.csv
ob-analytics lobster-demo /path/to/lobster_data --trading-date 2012-06-21

Pass -v / --verbose for debug-level logging.

cli ¶

Command-line interface for ob-analytics.

Entry point registered as ob-analytics in pyproject.toml.

Usage::

ob-analytics process orders.csv --output results/
ob-analytics process data/ --source lobster --trading-date 2012-06-21
ob-analytics process orders.csv --tick-size 0.001 --lot-size 0.0001
ob-analytics process orders.csv --cut 2015-05-01T02:00 --output windows/
ob-analytics audit orders.csv --strict
ob-analytics gallery results/ --output my_gallery/ --backend plotly
ob-analytics bitstamp-demo /path/to/dir_with_orders_and_trades/ --output demo_out/
ob-analytics bitstamp-demo --view comparison   # L2-vs-L3 counterparts side by side
ob-analytics lobster-demo /path/to/lobster_data --trading-date 2012-06-21 --output demo_out/
ob-analytics capture bitstamp --pair btcusd --minutes 30 --output /tmp/capture
ob-analytics capture ccxt --venue kraken --pair BTC/USD --output /tmp/kraken

ob-analytics capture <source> --help lists the flags of that source's settings.

main ¶

main(argv: list[str] | None = None) -> None

Entry point for the ob-analytics CLI.

argv is the arguments after the command name; None reads sys.argv.