Releases: hungson175/vnfin
Releases · hungson175/vnfin
Release list
vnfin v0.2.0
vnfin v0.2.0 — stability hardening + a new FX domain + AI-facing docs & skill.
Added
- API stability gate: a public-API surface snapshot test + compatibility-aware comparator that fails CI on any accidental breaking change (renames, reorders, unit/currency-default shifts, new required params, return-type changes). SemVer + deprecation policy in
docs/stability.md. - Upstream health monitoring (opt-in):
scripts/healthcheck.py+ privatevnfin/_health.py— schema-drift + value-sanity per source, sanitizedSTATUS.md/JSON. Never in CI; rate-limit-aware. - FX domain (
vnfin.fx): no-key daily/current rates vs VND (open.er-api → Vietcombank failover), canonical unit "VND per 1 base" + cross-rates, typedFXRate, two-layer unit guard. - AI documentation (
docs/ai-usage.md+llms.txt) and an Anthropic-style skill (skills/vnfin/) so AI agents can use the library; a docs-contract test keeps them in sync with the code.
Install
pip install git+https://github.com/hungson175/vnfin.gitNo API key required for the default path of any domain. Python ≥ 3.10. Apache-2.0.
vnfin v0.1.0
Clean-room OSS Python library for Vietnam financial-market data.
7 domains: prices, fundamentals, funds, indices, gold, crypto, macro.
- No-key-first defaults + optional bring-your-own-key (never bundled).
- Multi-source failover with a unit-homogeneity guard; explicit units/currency.
- 756 offline tests / 0 skipped / 94% coverage; 16 live tests; Apache-2.0.
Clean-room implementation; git history scrubbed of legacy token material.