finstore 0.1.0__tar.gz

finstore-0.1.0/.claude/settings.local.json

@@ -0,0 +1,8 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(python -m pytest tests/ -x -q)",
+      "Bash(uv build *)"
+    ]
+  }
+}

finstore-0.1.0/.gitignore

@@ -0,0 +1,12 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+dist/
+build/
+.venv/
+.env
+cache/
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+uv.lock

finstore-0.1.0/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+## [Unreleased]
+
+### Added
+- Initial extraction from `gnc-sfin-gateway`.
+- `finstore` core library: `Tenant`, `fetch()`, `Backend`/`Storage`/`Credentials` protocols,
+  `Account`/`Transaction`/`Connection`/`AccountSummary`/`Window` data model,
+  `FilesystemStorage` reference implementation, exception hierarchy rooted at `FinstoreError`.
+- `finstore[simplefin]` extra: `SimpleFINBackend`, `SimpleFINCredentials`, `FetchReport`.
+- `finstore[local]` extra: `finstore_local` self-hosted CLI (`fetch`, `serve`, `accounts`,
+  `validate`, `cache reset`) and FastAPI dashboard.

finstore-0.1.0/CLAUDE.md

@@ -0,0 +1,50 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Working agreements
+
+- **Do not commit without an explicit request from the user.**
+- Commit messages must not include a `Co-Authored-By` tag.
+
+## Commands
+
+```bash
+# Install (requires Python 3.11+)
+uv venv && source .venv/bin/activate && uv pip install -e ".[dev]"
+
+# Tests
+pytest tests/unit/          # unit tests only
+pytest tests/arch/          # import boundary invariants
+pytest tests/               # everything
+pytest tests/unit/store/test_writer.py  # single file
+
+# Lint / type-check
+ruff check src/ tests/
+mypy src/finstore src/finstore_local
+```
+
+## Architecture
+
+Two packages share one `src/` tree:
+
+- **`finstore`** — the public library. Backend-agnostic; no app-layer imports allowed.
+- **`finstore_local`** — the self-hosted CLI + dashboard. Imports `finstore`; not importable as API.
+
+Data flow: `SimpleFINBackend` fetches from the SimpleFIN HTTP API → normalizes `Sf*` types into neutral `finstore.model` types → calls `FilesystemStorage.merge_chunk()` to persist atomically per account.
+
+### Import boundaries (enforced by `tests/arch/`)
+
+1. `finstore.*` must not import `finstore_local.*`
+2. `finstore.model.*` and `finstore.storage.*` must not import `finstore.backends.*`
+3. `Sf*` types are confined to `finstore.backends.simplefin.*` — they never cross the normalization seam in `backend.py`
+
+### Key design points
+
+**Normalization seam** — `SimpleFINBackend` in `backends/simplefin/backend.py` is the only place `Sf*` → model conversion happens. `models.py` holds raw SimpleFIN shapes; `client.py` is pure HTTP and returns `SfResponse`; `backend.py` converts and persists.
+
+**Protocols** — `Backend`, `Storage`, and `Credentials` in `finstore/protocols.py` define the contract. `SimpleFINBackend` and `FilesystemStorage` satisfy them structurally. `Credentials` is an empty marker; each backend defines its own frozen dataclass.
+
+**Tenant scoping** — every `Storage` method accepts `tenant_id: str`. `FilesystemStorage` is single-tenant and ignores it (all data lands under the same root), but the parameter must be threaded through — never hardcode `"local"` outside `finstore_local`.
+
+**`finstore_local` settings** — use `load_settings(env_file)` from `finstore_local.config` in all CLI commands. It returns the cached singleton when `env_file` is `None` and constructs a fresh instance for an alternate env file. Do not call `get_settings()` directly in CLI commands.

finstore-0.1.0/LICENSE

@@ -0,0 +1,170 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship made available under
+      the License, as indicated by a copyright notice that is included in
+      or attached to the work (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other transformations
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and its Derivative Works thereof.
+
+      "Contribution" shall mean, as submitted to the Licensor for inclusion
+      in the Work by the copyright owner or by an individual or Legal Entity
+      authorized to submit on behalf of the copyright owner. For the purposes
+      of this definition, "submitted" means any form of electronic, verbal,
+      or written communication sent to the Licensor or its representatives,
+      including but not limited to communication on electronic mailing lists,
+      source code control systems, and issue tracking systems that are managed
+      by, or on behalf of, the Licensor for the purpose of discussing and
+      improving the Work, but excluding communication that is conspicuously
+      marked or designated in writing by the copyright owner as "Not a
+      Contribution."
+
+      "Contributor" shall mean Licensor and any Legal Entity on behalf of
+      whom a Contribution has been received by the Licensor and included
+      within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by the combination of their Contributions
+      with the Work to which such Contributions were submitted. If You
+      institute patent litigation against any entity (including a cross-claim
+      or counterclaim in a lawsuit) alleging that the Work or any patent
+      claim embodied within the Work constitutes direct or indirect patent
+      infringement, then any patent licenses granted to You under this
+      License for that Work shall terminate as of the date such litigation
+      is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, You must include a readable copy of the
+          attribution notices contained within such NOTICE file, in
+          at least one of the following places: within a NOTICE text
+          file distributed as part of the Derivative Works; within
+          the Source form or documentation, if provided along with the
+          Derivative Works; or, within a display generated by the
+          Derivative Works, if and wherever such third-party notices
+          normally appear. The contents of the NOTICE file are for
+          informational purposes only and do not modify the License.
+          You may add Your own attribution notices within Derivative
+          Works that You distribute, alongside or in addition to the
+          NOTICE text from the Work, provided that such additional
+          attribution notices cannot be construed as modifying the License.
+
+      You may add Your own license statement for Your modifications and
+      may provide additional grant of rights to use, copy, modify, merge,
+      publish, distribute, sublicense, and/or sell copies of the
+      Derivative Works, as conditions for such additional rights; and
+
+      You may add additional license statement in the NOTICE text
+      alongside the LICENSE text in the Work.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any conditions of TITLE,
+      NONINFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR
+      PURPOSE. You are solely responsible for determining the
+      appropriateness of using or reproducing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or exemplary damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or all other
+      commercial damages or losses), even if such Contributor has been
+      advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may offer only
+      conditions consistent with this License and not in the form of
+      additional liability conditions, imposing obligations not consistent
+      with this License, or conditions on behalf of any Contributor.
+
+   END OF TERMS AND CONDITIONS

finstore-0.1.0/PKG-INFO

@@ -0,0 +1,95 @@
+Metadata-Version: 2.4
+Name: finstore
+Version: 0.1.0
+Summary: Backend-agnostic local repository of a user's financial data
+Project-URL: Homepage, https://github.com/stevel408/finstore
+Project-URL: Repository, https://github.com/stevel408/finstore
+Project-URL: Bug Tracker, https://github.com/stevel408/finstore/issues
+Author-email: Steven Li <steve.98@gmail.com>
+License: Apache-2.0
+License-File: LICENSE
+Keywords: banking,finance,financial-data,gnucash,ofx,personal-finance,simplefin
+Requires-Python: >=3.11
+Requires-Dist: platformdirs>=4
+Requires-Dist: pydantic>=2
+Provides-Extra: dev
+Requires-Dist: fastapi>=0.110; extra == 'dev'
+Requires-Dist: httpx>=0.27; extra == 'dev'
+Requires-Dist: import-linter>=2.1; extra == 'dev'
+Requires-Dist: itsdangerous>=2.1; extra == 'dev'
+Requires-Dist: jinja2>=3.1; extra == 'dev'
+Requires-Dist: mypy>=1.10; extra == 'dev'
+Requires-Dist: pydantic-settings>=2.2; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest-httpx>=0.30; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: python-multipart>=0.0.9; extra == 'dev'
+Requires-Dist: ruff>=0.4; extra == 'dev'
+Requires-Dist: typer>=0.12; extra == 'dev'
+Requires-Dist: uvicorn[standard]>=0.27; extra == 'dev'
+Provides-Extra: local
+Requires-Dist: fastapi>=0.110; extra == 'local'
+Requires-Dist: httpx>=0.27; extra == 'local'
+Requires-Dist: itsdangerous>=2.1; extra == 'local'
+Requires-Dist: jinja2>=3.1; extra == 'local'
+Requires-Dist: pydantic-settings>=2.2; extra == 'local'
+Requires-Dist: python-multipart>=0.0.9; extra == 'local'
+Requires-Dist: typer>=0.12; extra == 'local'
+Requires-Dist: uvicorn[standard]>=0.27; extra == 'local'
+Provides-Extra: simplefin
+Requires-Dist: httpx>=0.27; extra == 'simplefin'
+Description-Content-Type: text/markdown
+
+# finstore
+
+Backend-agnostic local repository of a user's financial data.
+
+## Install
+
+```bash
+# Library only (for custom integrations / the gnc-sfin-gateway OFX server)
+pip install finstore
+
+# Library + SimpleFIN backend
+pip install finstore[simplefin]
+
+# Self-hosted CLI + dashboard (end users)
+pipx install 'finstore[local]'
+```
+
+## Quick start
+
+```python
+import asyncio
+import time
+from pathlib import Path
+
+import httpx
+
+from finstore import Tenant, fetch
+from finstore.backends.simplefin import SimpleFINBackend, SimpleFINCredentials
+from finstore.storage.filesystem import FilesystemStorage
+
+tenant  = Tenant(id="local")
+storage = FilesystemStorage(root=Path("~/.local/share/finstore").expanduser())
+creds   = SimpleFINCredentials(access_url="https://user:pass@bridge.simplefin.org/simplefin")
+
+dtstart = int(time.time()) - 90 * 86400  # last 90 days
+
+async def main() -> None:
+    async with httpx.AsyncClient() as http_client:
+        backend = SimpleFINBackend(credentials=creds, httpx_client=http_client)
+        await fetch(tenant, backend, storage, window=(dtstart, None))
+
+    accounts = storage.list_accounts(tenant.id)
+
+asyncio.run(main())
+```
+
+## Development
+
+See [docs/contributing.md](docs/contributing.md) for setup, running tests, linting, and CLI usage.
+
+## License
+
+Apache-2.0

finstore-0.1.0/README.md

@@ -0,0 +1,53 @@
+# finstore
+
+Backend-agnostic local repository of a user's financial data.
+
+## Install
+
+```bash
+# Library only (for custom integrations / the gnc-sfin-gateway OFX server)
+pip install finstore
+
+# Library + SimpleFIN backend
+pip install finstore[simplefin]
+
+# Self-hosted CLI + dashboard (end users)
+pipx install 'finstore[local]'
+```
+
+## Quick start
+
+```python
+import asyncio
+import time
+from pathlib import Path
+
+import httpx
+
+from finstore import Tenant, fetch
+from finstore.backends.simplefin import SimpleFINBackend, SimpleFINCredentials
+from finstore.storage.filesystem import FilesystemStorage
+
+tenant  = Tenant(id="local")
+storage = FilesystemStorage(root=Path("~/.local/share/finstore").expanduser())
+creds   = SimpleFINCredentials(access_url="https://user:pass@bridge.simplefin.org/simplefin")
+
+dtstart = int(time.time()) - 90 * 86400  # last 90 days
+
+async def main() -> None:
+    async with httpx.AsyncClient() as http_client:
+        backend = SimpleFINBackend(credentials=creds, httpx_client=http_client)
+        await fetch(tenant, backend, storage, window=(dtstart, None))
+
+    accounts = storage.list_accounts(tenant.id)
+
+asyncio.run(main())
+```
+
+## Development
+
+See [docs/contributing.md](docs/contributing.md) for setup, running tests, linting, and CLI usage.
+
+## License
+
+Apache-2.0

finstore-0.1.0/docs/api-reference.md

@@ -0,0 +1,264 @@
+# finstore — Public API Reference (0.1)
+
+Changes to anything listed here require a minor (new symbol) or major
+(changed/removed symbol) version bump and a CHANGELOG entry. Everything else
+is free to change between patch releases.
+
+---
+
+## Top-level (`finstore`)
+
+```python
+from finstore import fetch, Tenant, Window, FinstoreError
+from finstore import BackendError, StorageError, CredentialError, ValidationError
+```
+
+### `Tenant`
+
+```python
+@dataclass(frozen=True)
+class Tenant:
+    id: str
+```
+
+Pure identity token. The local app uses `Tenant(id="local")`. A future
+multi-tenant deployment would derive the id from auth. Every storage call is
+scoped to a tenant.
+
+### `Window`
+
+```python
+Window = tuple[int, int | None]
+```
+
+`(dtstart_epoch, dtend_epoch_or_none)`. Epoch seconds UTC. `None` on the upper
+bound means "no upper limit." Bounds are inclusive at both the backend and the
+storage reader.
+
+### `fetch()`
+
+```python
+async def fetch(
+    tenant: Tenant,
+    backend: Backend,
+    storage: Storage,
+    *,
+    window: Window,
+) -> Any
+```
+
+Fetch one window of financial data via `backend` and persist it into `storage`
+under `tenant`. Returns the backend's report object (today: `FetchReport` from
+`SimpleFINBackend`).
+
+**Cancellation:** `asyncio.CancelledError` propagates to the caller. Any
+`storage.merge_chunk()` calls that completed before cancellation are kept on
+disk; the in-flight chunk is dropped. No rollback is attempted.
+
+### Exception hierarchy
+
+```
+FinstoreError
+├── BackendError        # backend fetch failed (network, auth, upstream error)
+├── StorageError        # storage read/write failed
+│   ├── CacheMissError          (finstore.storage)
+│   ├── CacheEmptyError         (finstore.storage)
+│   ├── CacheCorruptError       (finstore.storage)
+│   └── CacheSchemaMismatchError (finstore.storage)
+├── CredentialError     # credentials missing, malformed, or rejected
+└── ValidationError     # data crossing a public boundary failed validation
+```
+
+---
+
+## Data model (`finstore.model`)
+
+```python
+from finstore.model import Account, Transaction, Connection, AccountSummary, StorageChunk, Window
+```
+
+All model types are **frozen dataclasses**. Fields listed here are guaranteed
+at 0.1; backends may not populate optional fields (marked below).
+
+### `Account`
+
+| Field | Type | Notes |
+|---|---|---|
+| `id` | `str` | Backend-assigned identifier (e.g. raw SimpleFIN id) |
+| `name` | `str` | Display name |
+| `currency` | `str` | ISO 4217 code (e.g. `"USD"`) |
+| `balance` | `Decimal` | Ledger balance |
+| `available_balance` | `Decimal \| None` | May be absent |
+| `balance_date` | `int` | Epoch seconds UTC |
+| `conn_id` | `str` | Links to a `Connection` |
+| `transactions` | `tuple[Transaction, ...]` | |
+
+### `Transaction`
+
+| Field | Type | Notes |
+|---|---|---|
+| `id` | `str` | Backend-assigned identifier |
+| `posted` | `int` | Epoch seconds UTC |
+| `amount` | `Decimal` | Signed; `"0.00"` is valid (fee reversals) |
+| `description` | `str` | |
+| `payee` | `str` | |
+| `memo` | `str` | |
+| `transacted_at` | `int \| None` | When the transaction was initiated; may be absent |
+
+### `Connection`
+
+| Field | Type | Notes |
+|---|---|---|
+| `conn_id` | `str` | Stable identifier (e.g. institution domain) |
+| `org_name` | `str` | Human-readable institution name |
+| `org_id` | `str` | Backend-assigned institution id |
+| `org_domain` | `str` | Default `""` |
+| `sfin_url` | `str` | Default `""` |
+| `org_url` | `str` | Default `""` |
+
+### `AccountSummary`
+
+Lightweight stub returned by `Storage.list_accounts`. Does not include
+transactions.
+
+| Field | Type | Notes |
+|---|---|---|
+| `acctid` | `str` | Display id (e.g. sanitized account name) |
+| `name` | `str` | |
+| `currency` | `str` | |
+| `connection` | `Connection` | |
+| `last_fetch_at` | `int \| None` | `None` if never fetched |
+| `txn_count` | `int` | Total stored transactions |
+
+### `StorageChunk`
+
+Unit of normalized data produced by a backend and consumed by `Storage.merge_chunk`.
+
+| Field | Type |
+|---|---|
+| `accounts` | `tuple[Account, ...]` |
+| `connections` | `tuple[Connection, ...]` |
+
+---
+
+## Protocols (`finstore.protocols`)
+
+```python
+from finstore.protocols import Backend, Storage, Credentials
+```
+
+All three are `@runtime_checkable`. See `docs/architecture.md` for the
+full method signatures and rationale.
+
+---
+
+## Storage (`finstore.storage`)
+
+```python
+from finstore.storage.filesystem import FilesystemStorage
+from finstore.storage import (
+    CacheMissError, CacheEmptyError, CacheCorruptError, CacheSchemaMismatchError,
+    CacheMeta, CachedAccount, AccountMeta, MergeStats,
+)
+```
+
+### `FilesystemStorage(root: Path)`
+
+Reference `Storage` implementation. Single-writer invariant: only one process
+should call `merge_chunk` at a time. Reads are safe to concurrent callers.
+
+Constructor argument `root` is the storage directory (e.g.
+`~/.local/share/finstore`). The directory and `accounts/` subdirectory must
+exist before the first write; `finstore_local.config` creates them.
+
+### Return types
+
+**`MergeStats`** — returned by `merge_chunk`.
+
+| Field | Type |
+|---|---|
+| `accounts_seen` | `int` |
+| `txns_new` | `int` |
+| `txns_duplicate` | `int` |
+
+**`CacheMeta`** — returned by `read_meta`.
+
+| Field | Type |
+|---|---|
+| `schema_version` | `int` |
+| `last_fetch_at` | `int` |
+| `connections` | `tuple[Connection, ...]` |
+| `accounts` | `dict[str, AccountMeta]` |
+
+**`CachedAccount`** — returned by `read_account` and `read_account_window`.
+
+| Field | Type |
+|---|---|
+| `account` | `Account` |
+| `display_id` | `str` |
+
+**`AccountMeta`**
+
+| Field | Type |
+|---|---|
+| `last_fetch_at` | `int` |
+| `txn_count` | `int` |
+| `earliest_posted` | `int \| None` |
+| `latest_posted` | `int \| None` |
+| `conn_id` | `str` |
+
+---
+
+## SimpleFIN backend (`finstore.backends.simplefin`)
+
+Requires the `[simplefin]` extra (`pip install finstore[simplefin]`).
+
+```python
+from finstore.backends.simplefin import SimpleFINBackend, SimpleFINCredentials, FetchReport
+```
+
+### `SimpleFINCredentials`
+
+```python
+@dataclass(frozen=True)
+class SimpleFINCredentials:
+    access_url: str
+```
+
+Structurally satisfies the `Credentials` marker.
+
+### `SimpleFINBackend`
+
+```python
+SimpleFINBackend(
+    credentials: SimpleFINCredentials,
+    httpx_client: httpx.AsyncClient | None = None,
+)
+```
+
+Satisfies the `Backend` protocol. `httpx_client` is optional; if omitted the
+backend creates and closes its own client per `fetch_and_persist` call.
+
+### `FetchReport`
+
+Returned by `fetch()` when the backend is `SimpleFINBackend`.
+
+| Field | Type |
+|---|---|
+| `chunks` | `int` |
+| `accounts_seen` | `int` |
+| `txns_new` | `int` |
+| `txns_duplicate` | `int` |
+| `errors` | `list[str]` |
+
+---
+
+## What is NOT public API
+
+- `finstore.backends.simplefin.models` — the `Sf*` types are backend-internal.
+  Do not import them; the arch tests will catch violations.
+- `finstore_local.*` — the self-hosted app modules. The CLI command shape
+  (`finstore fetch`, `finstore serve`, etc.) and dashboard URL paths are
+  public surface; the Python modules behind them are not.
+- `finstore.storage._schema` — internal schema constants.
+- Anything prefixed `_`.