bagel-tushare 3.0.0

A Python wrapper for Tushare, a Chinese financial data provider. The project provides a simple and easy-to-use automation tool for **downloading** financial data from Tushare, and **storing** the data in a local mysql database.

bagel-tushare

Author: Yanzhong(Eric) Huang bagelquant

A Python wrapper for Tushare, a Chinese financial data provider. The project provides a simple and easy-to-use automation tool for downloading financial data from Tushare, and storing the data in a local mysql database.

• Tushare
• Tushare API documentation

Features

1. Download data from Tushare
2. Store data in a local mysql database
3. Query quickly from the local mysql database
4. Update data in the local mysql database

Installation

pip install bagel-tushare

Development

uv sync
uv run pytest

See docs/testing.md for test strategy, markers, and how to run legacy unittest tests.

By default tests run fully offline using an in-memory SQLite database.

If you add integration tests (e.g. MySQL/Postgres/Tushare network), mark them with @pytest.mark.integration and run them explicitly:

uv run pytest -m integration

Usage

from bageltushare import download, update_by_date, update_by_code
from bageltushare import create_index, create_all_tables, get_engine


# configs
HOST = "localhost"
PORT = 3306
USER = "root"
PASSWORD = "<YOUR_PASSWORD>"
DB = "<DATABASE_NAME>"

# db_type supports: "sqlite", "mysql", "mariadb"
ENGINE = get_engine(host=HOST, port=PORT, user=USER, password=PASSWORD, database=DB, db_type="mysql")
TOKEN = "<YOUR_TOKEN>"

def main() -> None:
    by_date_apis = [
        "daily",
        "adj_factor",
    ]

    by_code_apis = [
        "balancesheet",
        "cashflow",
        "income",
    ]

    create_all_tables(engine=ENGINE)

    # download and replace table
    download(engine=ENGINE, token=TOKEN, api_name="trade_cal")
    download(engine=ENGINE,
             token=TOKEN,
             api_name="stock_basic",
             params={"list_status": "L, D, P"},
             fields=[
                 "ts_code",
                 "symbol",
                 "name",
                 "area",
                 "industry",
                 "cnspell",
                 "market",
                 "list_date",
                 "act_name",
                 "act_ent_type",
                 "fullname",
                 "enname",
                 "exchange",
                 "curr_type",
                 "list_status",
                 "delist_date",
                 "is_hs"
             ])

    for api in by_date_apis:
        update_by_date(engine=ENGINE, token=TOKEN, api_name=api)
        create_index(engine=ENGINE, table_name=api)

    for api in by_code_apis:
        update_by_code(engine=ENGINE, token=TOKEN, api_name=api)
        create_index(engine=ENGINE, table_name=api)

if __name__ == "__main__":
    main()

License

This project is licensed under the MIT License. See the LICENSE file for details.