onefinance 0.1.0__tar.gz

onefinance-0.1.0/.gitignore

@@ -0,0 +1,254 @@
+# Created by https://www.toptal.com/developers/gitignore/api/vim,visualstudiocode,python,macos
+# Edit at https://www.toptal.com/developers/gitignore?templates=vim,visualstudiocode,python,macos
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### macOS Patch ###
+# iCloud generated files
+*.icloud
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+### Python Patch ###
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+poetry.toml
+
+# ruff
+.ruff_cache/
+
+# LSP config files
+pyrightconfig.json
+
+### Vim ###
+# Swap
+[._]*.s[a-v][a-z]
+!*.svg  # comment out if you don't need vector files
+[._]*.sw[a-p]
+[._]s[a-rt-v][a-z]
+[._]ss[a-gi-z]
+[._]sw[a-p]
+
+# Session
+Session.vim
+Sessionx.vim
+
+# Temporary
+.netrwhist
+*~
+# Auto-generated tag files
+tags
+# Persistent undo
+[._]*.un~
+
+### VisualStudioCode ###
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+!.vscode/*.code-snippets
+
+# Local History for Visual Studio Code
+.history/
+
+# Built Visual Studio Code Extensions
+*.vsix
+
+### VisualStudioCode Patch ###
+# Ignore all local history of files
+.history
+.ionide
+
+# End of https://www.toptal.com/developers/gitignore/api/vim,visualstudiocode,python,macos
+
+### uv ###
+# uv.lock is committed for reproducibility (do NOT ignore it)
+# Build artifacts from `uv build`
+dist/

onefinance-0.1.0/.python-version

@@ -0,0 +1 @@
+3.13

onefinance-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Syi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

onefinance-0.1.0/PKG-INFO

@@ -0,0 +1,175 @@
+Metadata-Version: 2.4
+Name: onefinance
+Version: 0.1.0
+Summary: One finance data client to rule them all — unified API across multiple financial data providers
+Project-URL: Repository, https://github.com/yishanhe/one-finance-data
+Author-email: Shanhe Yi <ysh@yishanhe.net>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Office/Business :: Financial
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.11
+Requires-Dist: diskcache>=5.6
+Requires-Dist: httpx
+Requires-Dist: pydantic>=2.0
+Requires-Dist: pyyaml
+Requires-Dist: yfinance
+Provides-Extra: cli
+Requires-Dist: rich; extra == 'cli'
+Requires-Dist: typer>=0.12; extra == 'cli'
+Description-Content-Type: text/markdown
+
+# one-finance-data
+
+Unified financial data client for Python. Abstracts FMP, Finnhub, Twelve Data, and Yahoo Finance behind a single interface with transparent disk-based caching and a CLI designed for agents and automation.
+
+## Installation
+
+```bash
+# Core library
+pip install -e "."
+
+# Core + CLI (ofclient)
+pip install -e ".[cli]"
+
+# Development
+pip install -e ".[dev,cli]"
+```
+
+## Environment variables
+
+| Variable | Provider | Required |
+|---|---|---|
+| `FMP_API_KEY` | Financial Modeling Prep | For FMPProvider |
+| `FINNHUB_API_KEY` | Finnhub | For FinnhubProvider |
+| `TWELVE_DATA_API_KEY` | Twelve Data | For TwelveDataProvider |
+
+Providers whose key is unset are skipped automatically. `YFinanceProvider` (no key) is always available as a fallback.
+
+## Python usage
+
+```python
+from onefinance.core.client import OneFinanceClient
+from datetime import date
+
+# Reads API keys from environment; builds all available providers automatically
+with OneFinanceClient() as client:
+    # Price history — cached 30 days (historical) or 6 h (after market close)
+    bars = client.get_price_history("AAPL", date(2024, 1, 1), date(2024, 12, 31))
+
+    # Live quote — cached 30 seconds
+    quote = client.get_quote("AAPL")
+
+    # Company info — cached 30 days
+    info = client.get_info("AAPL")
+
+    # Financial statements
+    income = client.get_financials("AAPL", statement="income", period="annual")
+
+    # Ratios — use fresh=True to bypass the long-TTL cache
+    ratios = client.get_ratios("AAPL", period="annual", fresh=True)
+
+    # Earnings
+    earnings = client.get_earnings("AAPL")
+
+    # Insider trades
+    trades = client.get_insider_trades("AAPL")
+```
+
+### Per-call overrides
+
+```python
+bars = client.get_price_history(
+    "AAPL",
+    date(2024, 1, 1), date(2024, 12, 31),
+    no_cache=True,          # bypass cache
+    provider="finnhub",     # force a specific provider
+    ttl=3600,               # custom TTL in seconds
+)
+```
+
+## CLI usage
+
+```bash
+# Discover what's available
+ofclient capabilities         # machine-readable command manifest (JSON)
+ofclient version              # package + schema version
+
+# Data commands (all output JSON by default)
+ofclient price AAPL --range 1y
+ofclient price AAPL --start 2024-01-01 --end 2024-12-31
+ofclient quote AAPL
+ofclient financials AAPL --statement income --period annual
+ofclient info AAPL
+ofclient insiders AAPL --since 2024-01-01
+ofclient ratios AAPL --period annual --fresh
+ofclient earnings AAPL
+
+# Output formats
+ofclient price AAPL --range 1m --format table
+ofclient price AAPL --range 1m --format csv
+
+# Dry-run: see cache key and whether a fetch would happen, without fetching
+ofclient price AAPL --range 1y --dry-run
+
+# Force a provider or bypass cache
+ofclient quote AAPL --provider finnhub --no-cache
+
+# Introspection
+ofclient cache stats
+ofclient providers status
+ofclient config show
+ofclient config init --output ./config.yaml
+```
+
+### Exit codes
+
+| Code | Meaning |
+|---|---|
+| 0 | Success |
+| 1 | Invalid argument (bad range, unknown statement, etc.) |
+| 2 | Provider error or rate limit |
+| 3 | Endpoint not supported by any configured provider |
+| 4 | Configuration error (missing API key, bad config file) |
+
+### Environment overrides for CLI
+
+| Variable | Effect |
+|---|---|
+| `OFCLIENT_OUTPUT` | Default output format (`json`, `table`, `csv`) |
+| `OFCLIENT_NO_CACHE` | Set `1` to bypass cache on all calls |
+| `OFCLIENT_DRY_RUN` | Set `1` to dry-run all calls |
+| `OFCLIENT_CONFIG` | Path to config YAML file |
+
+## Provider coverage
+
+| Endpoint | FMP | Finnhub | Twelve Data | YFinance |
+|---|---|---|---|---|
+| `get_price_history` | ✓ | ✓ | ✓ | ✓ |
+| `get_quote` | ✓ | ✓ | ✓ | — |
+| `get_info` | ✓ | ✓ | — | ✓ |
+| `get_financials` | ✓ | ✓ | — | — |
+| `get_ratios` | ✓ | ✓ | — | — |
+| `get_earnings` | ✓ | ✓ | — | — |
+| `get_insider_trades` | ✓ | ✓ | — | — |
+
+## Running tests
+
+```bash
+# Unit tests only (no network)
+python -m pytest tests/ -m "not integration"
+
+# All tests including live API calls (requires API keys in env)
+python -m pytest tests/ -m integration
+
+# Single provider integration test
+python -m pytest tests/integration/test_fmp_live.py -m integration -v
+```

onefinance-0.1.0/README.md

@@ -0,0 +1,146 @@
+# one-finance-data
+
+Unified financial data client for Python. Abstracts FMP, Finnhub, Twelve Data, and Yahoo Finance behind a single interface with transparent disk-based caching and a CLI designed for agents and automation.
+
+## Installation
+
+```bash
+# Core library
+pip install -e "."
+
+# Core + CLI (ofclient)
+pip install -e ".[cli]"
+
+# Development
+pip install -e ".[dev,cli]"
+```
+
+## Environment variables
+
+| Variable | Provider | Required |
+|---|---|---|
+| `FMP_API_KEY` | Financial Modeling Prep | For FMPProvider |
+| `FINNHUB_API_KEY` | Finnhub | For FinnhubProvider |
+| `TWELVE_DATA_API_KEY` | Twelve Data | For TwelveDataProvider |
+
+Providers whose key is unset are skipped automatically. `YFinanceProvider` (no key) is always available as a fallback.
+
+## Python usage
+
+```python
+from onefinance.core.client import OneFinanceClient
+from datetime import date
+
+# Reads API keys from environment; builds all available providers automatically
+with OneFinanceClient() as client:
+    # Price history — cached 30 days (historical) or 6 h (after market close)
+    bars = client.get_price_history("AAPL", date(2024, 1, 1), date(2024, 12, 31))
+
+    # Live quote — cached 30 seconds
+    quote = client.get_quote("AAPL")
+
+    # Company info — cached 30 days
+    info = client.get_info("AAPL")
+
+    # Financial statements
+    income = client.get_financials("AAPL", statement="income", period="annual")
+
+    # Ratios — use fresh=True to bypass the long-TTL cache
+    ratios = client.get_ratios("AAPL", period="annual", fresh=True)
+
+    # Earnings
+    earnings = client.get_earnings("AAPL")
+
+    # Insider trades
+    trades = client.get_insider_trades("AAPL")
+```
+
+### Per-call overrides
+
+```python
+bars = client.get_price_history(
+    "AAPL",
+    date(2024, 1, 1), date(2024, 12, 31),
+    no_cache=True,          # bypass cache
+    provider="finnhub",     # force a specific provider
+    ttl=3600,               # custom TTL in seconds
+)
+```
+
+## CLI usage
+
+```bash
+# Discover what's available
+ofclient capabilities         # machine-readable command manifest (JSON)
+ofclient version              # package + schema version
+
+# Data commands (all output JSON by default)
+ofclient price AAPL --range 1y
+ofclient price AAPL --start 2024-01-01 --end 2024-12-31
+ofclient quote AAPL
+ofclient financials AAPL --statement income --period annual
+ofclient info AAPL
+ofclient insiders AAPL --since 2024-01-01
+ofclient ratios AAPL --period annual --fresh
+ofclient earnings AAPL
+
+# Output formats
+ofclient price AAPL --range 1m --format table
+ofclient price AAPL --range 1m --format csv
+
+# Dry-run: see cache key and whether a fetch would happen, without fetching
+ofclient price AAPL --range 1y --dry-run
+
+# Force a provider or bypass cache
+ofclient quote AAPL --provider finnhub --no-cache
+
+# Introspection
+ofclient cache stats
+ofclient providers status
+ofclient config show
+ofclient config init --output ./config.yaml
+```
+
+### Exit codes
+
+| Code | Meaning |
+|---|---|
+| 0 | Success |
+| 1 | Invalid argument (bad range, unknown statement, etc.) |
+| 2 | Provider error or rate limit |
+| 3 | Endpoint not supported by any configured provider |
+| 4 | Configuration error (missing API key, bad config file) |
+
+### Environment overrides for CLI
+
+| Variable | Effect |
+|---|---|
+| `OFCLIENT_OUTPUT` | Default output format (`json`, `table`, `csv`) |
+| `OFCLIENT_NO_CACHE` | Set `1` to bypass cache on all calls |
+| `OFCLIENT_DRY_RUN` | Set `1` to dry-run all calls |
+| `OFCLIENT_CONFIG` | Path to config YAML file |
+
+## Provider coverage
+
+| Endpoint | FMP | Finnhub | Twelve Data | YFinance |
+|---|---|---|---|---|
+| `get_price_history` | ✓ | ✓ | ✓ | ✓ |
+| `get_quote` | ✓ | ✓ | ✓ | — |
+| `get_info` | ✓ | ✓ | — | ✓ |
+| `get_financials` | ✓ | ✓ | — | — |
+| `get_ratios` | ✓ | ✓ | — | — |
+| `get_earnings` | ✓ | ✓ | — | — |
+| `get_insider_trades` | ✓ | ✓ | — | — |
+
+## Running tests
+
+```bash
+# Unit tests only (no network)
+python -m pytest tests/ -m "not integration"
+
+# All tests including live API calls (requires API keys in env)
+python -m pytest tests/ -m integration
+
+# Single provider integration test
+python -m pytest tests/integration/test_fmp_live.py -m integration -v
+```

onefinance-0.1.0/onefinance/__init__.py

@@ -0,0 +1,74 @@
+"""OneFinance — unified financial data API across multiple providers."""
+
+from onefinance.core.client import OneFinanceClient
+from onefinance.core.errors import (
+    AllProvidersFailedError,
+    FinanceError,
+    NotSupportedError,
+    ProviderError,
+    RateLimitError,
+)
+from onefinance.indicators import TechnicalIndicators, compute_indicators
+from onefinance.core.models import (
+    AnalystData,
+    BalanceSheet,
+    CashFlow,
+    CompanyInfo,
+    CorporateAction,
+    Currency,
+    DCFValuation,
+    EarningsRecord,
+    FinancialRatios,
+    FinanceModel,
+    ForwardEstimates,
+    IncomeStatement,
+    InsiderTrade,
+    InstitutionalHolder,
+    NewsArticle,
+    OptionChain,
+    OptionContract,
+    PriceBar,
+    Quote,
+    ScreenerResult,
+    SectorInfo,
+    Symbol,
+)
+
+__all__ = [
+    # Client
+    "OneFinanceClient",
+    # Models
+    "AnalystData",
+    "FinanceModel",
+    "PriceBar",
+    "Quote",
+    "IncomeStatement",
+    "BalanceSheet",
+    "CashFlow",
+    "CompanyInfo",
+    "CorporateAction",
+    "DCFValuation",
+    "EarningsRecord",
+    "FinancialRatios",
+    "ForwardEstimates",
+    "InsiderTrade",
+    "InstitutionalHolder",
+    "NewsArticle",
+    "OptionChain",
+    "OptionContract",
+    "ScreenerResult",
+    "SectorInfo",
+    "Symbol",
+    "Currency",
+    # Errors
+    "FinanceError",
+    "ProviderError",
+    "NotSupportedError",
+    "RateLimitError",
+    "AllProvidersFailedError",
+    # Indicators
+    "TechnicalIndicators",
+    "compute_indicators",
+]
+
+__version__ = "0.1.0"

onefinance-0.1.0/onefinance/audit/__init__.py

@@ -0,0 +1,23 @@
+"""Audit log — structured tracing for every API invocation.
+
+Records provider calls, cache hits, tier-walking decisions, and
+errors so you can answer "which provider served this?" and
+"how many FMP calls did I burn today?"
+
+Usage::
+
+    from onefinance.audit import AuditLog, AuditEntry, AuditStats
+
+    log = AuditLog()
+    entries = log.query(provider="fmp", limit=10)
+    stats = log.stats()
+"""
+
+from onefinance.audit.models import AuditEntry, AuditStats
+from onefinance.audit.log import AuditLog
+
+__all__ = [
+    "AuditEntry",
+    "AuditLog",
+    "AuditStats",
+]