Shadow Ingest Local Testing¶

This page gives a minimal setup that lets users copy, paste, and run the examples in this documentation locally.

1. Install¶

uv pip install git+ssh://git@github.com/Fund-Sapiens/shadow-ingest.git

2. Configure Remote Service Mode¶

export SHADOW_INGEST_REMOTE_URL=http://YOUR_SERVER_HOST:30110
export SHADOW_INGEST_FLIGHT_URL=grpc://YOUR_SERVER_HOST:30100

For most users, this is the correct setup.

3. Quick Connectivity Check¶

import shadow_ingest as si

trade_dates = si.list_market_calendar(year=2024)
trade_date = trade_dates[0].isoformat()

print(trade_dates[:5])
print(si.list_universe(date=trade_date)[:5])
print(si.get_industry_standards())
print(
    si.get_industry_mapping(
        ["000001.XSHE"],
        standard="sws",
        trade_date=trade_date,
    ).head()
)

If these calls work, the examples on the API pages should also work.

4. Pandas Users¶

The SDK returns polars.DataFrame by default.

If you prefer pandas:

pdf = df.to_pandas()