Skip to main content

Standard financial ETL workflows

Project description

finance etl

Standard financial ETL workflows

Build Status codecov License PyPI

Overview

finance-etl provides reusable finance-specific ETL adapters on top of ccflow and the generic ccflow-* connector packages. It owns public finance data access concerns such as trading calendars, market sessions, provider request planning, credential config shapes, and finance-aware backfill helpers.

Applications compose these adapters into workflows and decide where data is stored. Provider credentials, private paths, and deployment-specific destinations stay outside this package.

Quick Start

Compose the packaged calendar registry with ccflow-etl, then point a context at an explicit calendar path:

defaults:
    - /backfill: daily
    - /finance_calendars: default
    - _self_

hydra:
    searchpath:
        - pkg://ccflow_etl.config
        - pkg://finance_etl.config

context:
    start_datetime: 2024-07-01
    end_datetime: 2024-07-05
    calendar: /calendars/exchange/XNYS

Calendar paths are namespaced by code, for example /calendars/exchange/XNYS, /calendars/exchange/XTKS/session/starts, /calendars/country/JP, and /calendars/region/us.

Python callers use the same code-parameterized objects, such as ExchangeCalendar["XNYS"], RegionCalendar["US"], and CountryCalendar["JP"].

Provider credentials are composed through Hydra groups. For Massive REST access:

defaults:
    - /credentials: massive
    - _self_

The packaged credential config reads secrets from environment variables; it does not store secrets in public package config.

Massive also publishes reusable dataset and provider catalog entries:

defaults:
    - /credentials: massive
    - /datasets: massive
    - /providers: massive
    - _self_

The catalog registers the Hydra-friendly key datasets.massive_daily_ticker_summary for the semantic dataset massive-daily-ticker-summary, plus providers.massive for Massive REST request planning. Applications can compose those objects into MassiveDailyTickerSummaryModel and keep destinations or production overlays private.

Documentation

Dependency Contract

  • May depend on ccflow, ccflow-etl, ccflow-http, ccflow-s3, finance-dates, and finance-flow.
  • Should keep provider credentials and deployment-specific storage destinations out of package code.
  • Must not depend on application-specific packages.

Test Convention

Default tests should use synthetic market calendars and recorded or generated provider-shaped responses. They should not require live provider credentials, live S3, or live databases.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

finance_etl-0.1.0.tar.gz (21.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

finance_etl-0.1.0-py3-none-any.whl (25.0 kB view details)

Uploaded Python 3

File details

Details for the file finance_etl-0.1.0.tar.gz.

File metadata

  • Download URL: finance_etl-0.1.0.tar.gz
  • Upload date:
  • Size: 21.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for finance_etl-0.1.0.tar.gz
Algorithm Hash digest
SHA256 273ea503c16a77b2465e2afd6895e4b0770879a9cefb1265451383d77774a4e9
MD5 e1495045b4509ffdf2e7f709b4f5a968
BLAKE2b-256 493edcd49afca5a0a65f69b40819d16cb1d820b4e49244b81fca06a5f84e20d4

See more details on using hashes here.

File details

Details for the file finance_etl-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: finance_etl-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 25.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for finance_etl-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e0185c94fa22190c3058454165d33622ba78e6009fe74a932c8147f4046f3317
MD5 2071cb0215c3d0dbb2c87bfb6aa3c984
BLAKE2b-256 2c225188b2ab8ac04dc0768b7ea443a003b0afdf69879e34ab5a40ababaabf81

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page