Skip to content

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 --input 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/ --format lobster --trading-date 2012-06-21
ob-analytics gallery results/parquet/ --output my_gallery/
ob-analytics bitstamp-demo --input /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 --out /tmp/capture

main

main() -> None

Entry point for the ob-analytics CLI.