finance-yahoo-test / README.md
ZipLime's picture
Update README.md
54557a6 verified
|
Raw
History Blame Contribute Delete
2.14 kB
metadata
license: unknown
tags:
  - finance
  - stock-market
  - trading
  - backtesting
  - zipline
  - ziplime
task_categories:
  - time-series-forecasting
size_categories:
  - 1K<n<10K

finance-yahoo-test

Status: test / placeholder. This is a scratch dataset used to validate the ziplime → Hugging Face publishing pipeline (schema, partitioning, ziplime bundle ingest). Do not use for research or trading decisions yet — coverage and update cadence are not finalized.

Overview

Daily OHLCV price bars for a small set of US equities, sourced from Yahoo Finance, packaged as a ziplime data bundle. This card documents the format ziplime bundles published on the Hub will follow.

  • Source: Yahoo Finance (via yfinance)
  • Frequency: daily
  • Format: Parquet, hive-partitioned
  • Engine: loadable directly via ziplime bundle ingest --bundle-name finance-yahoo-test

Schema

Column Type Description
symbol string Ticker symbol
date date Trading session date
open float64 Open price
high float64 High price
low float64 Low price
close float64 Close price
volume int64 Volume

How to load

import polars as pl

df = pl.read_parquet("hf://datasets/ZipLime/finance-yahoo-test/data/*.parquet")

Or via ziplime directly:

ziplime bundle ingest --bundle-name finance-yahoo-test --source hf://ZipLime/finance-yahoo-test

Coverage

  • Symbols: [TODO — list or count]
  • Date range: [TODO]
  • Update schedule: none yet (static test snapshot)

License & source terms

Data sourced from Yahoo Finance for testing purposes. License TBD — Yahoo Finance data has usage restrictions that need review before this dataset is treated as anything beyond an internal test fixture. Do not redistribute commercially until this is resolved.

About ziplime

ziplime is an open-source backtesting engine (successor to Zipline) with native support for point-in-time datasets. github.com/Limex-com/ziplime