quantlab.dataset.sharadar.stores.write_ticker_sidecars#

quantlab.dataset.sharadar.stores.write_ticker_sidecars(download_dir, data_dir)[source]#

Write <store>.sharadar_tickers.json beside each existing price store.

The sidecar names each permaticker of the store by the tickers and companies it had over time, from the TICKERS and ACTIONS tables of the raw tier (SharadarStockDataset.write_ticker_sidecar). The stores are only read; a price store not built is skipped.

Parameters:
download_dirstr or Path

The download root holding the raw tier (sharadar/).

data_dirstr or Path

The data root holding the stores.

Returns:
dict of str to Path

Each price store found and the sidecar written; empty when none is.

Examples

>>> write_ticker_sidecars("/nonexistent/downloads", "/nonexistent")
{}