Journal

Trade journal service for entries, trade logging, execution-quality analytics, and realised P&L tracking.

Part of FlintTrade — the open-source self-hosted trading software monorepo built with Python, React, TypeScript, and Rust.

Language: Python

Public surfaceCopy Anchor Link

• src/flinttrade_journal/trade_journal.py — journal-entry model and storage helpers
• src/flinttrade_journal/order_analytics.py — execution-quality analytics
• src/flinttrade_journal/pnl_tracker.py — realised P&L calculations

(See the source for the full surface.)

InstallCopy Anchor Link

This package is part of the FlintTrade monorepo. Install via the workspace from the repo root:

uv pip install -e packages/services/journal

If you only want to use the package in isolation, the package's pyproject.toml, Cargo.toml, or package.json lists its dependencies. The supported path is the root workspace.

TestsCopy Anchor Link

python -m pytest packages/services/journal/tests/ -v --import-mode=importlib

For the full test matrix, see the contributor guide at docs/DEVELOPER_GUIDE.md.

How this fits inCopy Anchor Link

This package's role in the wider FlintTrade architecture is documented in docs/ARCHITECTURE.md. For end-user features it powers, see docs/USER_GUIDE.md.

ContributingCopy Anchor Link

Contributions welcome. Please read contributing.md at the repo root before opening a pull request.

LicenseCopy Anchor Link

AGPL-3.0 — same as the parent repository. See LICENSE for the full text.