Shadow Docs¶

Welcome to the unified documentation portal for internal shadow projects.

This site exists to give users and developers one stable documentation entrypoint instead of many separate project doc hosts.

Current Projects¶

Shadow Ingest¶

shadow-ingest is a dataframe-first market data query SDK and service.

Use it when you want to:

pull daily price history as a final dataframe
request daily cross-sectional snapshots
request the latest financial snapshot by statement type
access a maintained remote service without caring about transport details

Start here:

Shadow Octopus¶

shadow-octopus is the write-side collector for the Shadow stack.

It acquires data from configured websites, APIs, feeds, and manual inputs, then writes source-local raw records, object manifests, and downloaded objects. It does not provide a public API; downstream query and serving belong to shadow-lighthouse.

Use it when you want to:

configure and run source acquisition
backfill source history into the raw contract
download and track raw objects
inspect source checkpoints and run records
maintain the list of supported information sources

Start here:

Shadow Lighthouse¶

shadow-lighthouse is the read-side service for extraction, indexing, lookup, and serving over raw data written by shadow-octopus.

Use it when you want to:

build source-local read indexes from Octopus raw workspaces
list and search documents across initialized sources
query documents by issuer, stock code, raw id, or AI-facing id
serve local object metadata, files, and derived artifacts over HTTP

Start here:

Shadow Factor¶

shadow-factor is the factor engine in the Shadow stack.

It treats source data as factor material, and uses a formula-oriented DSL to generate reusable factors from financial and market fields.

Start here:

Shadow¶

shadow is the master project that combines the major components in the Shadow stack.

It is designed to connect shadow-ingest, shadow-factor, and the execution layer into one coherent workflow for strategy specification, industry-level batch backtesting, and reporting.

Start here: