Skip to main content

Financial analysis reports for a finance vault

Project description

fincraft

Financial analysis reports for a finance vault — a command-line tool that turns a watchlist markdown note into a full markdown performance report.

fincraft is layout-agnostic: it takes explicit paths, parses a watchlist note's frontmatter, and writes a markdown report to stdout (or a file). It reads no environment variables itself and never scans or writes a vault — orchestration (finding notes, saving reports) is the caller's job.

Install

uvx fincraft --help
# or
pip install fincraft

Price data is fetched via bardata; the Tiingo and Massive sources are bundled. The data source and credentials are resolved from the environment (e.g. BARDATA_DEFAULT_ENDOFDAY=tiingo, TIINGO_API_KEY=…).

Usage

fincraft perf-report Watchlists/momentum-etfs.md            # report to stdout
fincraft perf-report Watchlists/momentum-etfs.md -o out.md  # write to a file
fincraft perf-report --tickers QUAL,MTUM,SPY --benchmark SPY

fincraft watchlists Watchlists/        # list watchlist notes in a directory
fincraft show Watchlists/momentum-etfs.md   # parsed frontmatter

Watchlist notes

Any .md note with YAML frontmatter:

---
tickers: [MTUM, SPMO, VFMO]
benchmark: SPY        # or a list [SPY, QQQ]; first is primary
basket: true          # add an equal-weight basket as an extra benchmark
---

See sample-vault/ for a complete worked example.

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

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

fincraft-0.0.3-py3-none-any.whl (15.8 kB view details)

Uploaded Python 3

File details

Details for the file fincraft-0.0.3-py3-none-any.whl.

File metadata

  • Download URL: fincraft-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 15.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.13 {"installer":{"name":"uv","version":"0.9.13"},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"25.04","id":"plucky","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for fincraft-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a0fe904db9514bebaa03d23a556f0eb2120b2f81ce70b0ffa3f2e92d8ec7d5e2
MD5 5383a401a845ccd3ffb26522ded38183
BLAKE2b-256 0e31832742b2fee2cf06b0e2f1312aceccb4c9fab530e1c8e7249daf4f62d31b

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