Metadata-Version: 2.4
Name: sirop
Version: 0.1.0
Summary: Canadian/Quebec bitcoin tax calculator
License: MIT
License-File: LICENSE
Author: SLdM05
Author-email: SLdM05@proton.me
Requires-Python: >=3.12,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Dist: pydantic-settings (>=2.0,<3.0)
Requires-Dist: pyyaml (>=6.0,<7.0)
Project-URL: Homepage, https://github.com/SLdM05/sirop
Project-URL: Repository, https://github.com/SLdM05/sirop
Description-Content-Type: text/markdown

# sirop

Quebec maple syrup-themed crypto tax tool for Canadian tax filers.

Calculates capital gains, ACB, and superficial losses from exchange and wallet
transaction exports. Produces Schedule 3, Schedule G, and the Quebec
TP-21.4.39-V form.

Import formats for major Canadian exchanges and wallets are planned.

---

## Quickstart

Requires Python 3.12+ and [Poetry](https://python-poetry.org/).

```bash
git clone https://github.com/SLdM05/sirop.git
cd sirop
poetry install
cp .env.example .env   # fill in your values
```

## Quickstart workflow

```bash
# 1. Create a batch for your tax year
sirop create my2025tax --year 2025

# 2. Import your exchange exports
sirop tap ~/Downloads/ndax_2025_ledger.csv

# 3. Run the tax calculation pipeline
sirop boil
```

After `boil`, the `.sirop` file contains fully computed dispositions and
superficial-loss-adjusted gains, ready for `pour` (report generation).

## Documentation

See [`docs/usage/`](docs/usage/) for CLI usage guides:

- [Batch management — create, list, switch](docs/usage/sirop-create.md)
- [tap — import exchange transactions](docs/usage/sirop-tap.md)
- [boil — run the tax calculation pipeline](docs/usage/sirop-boil.md)

See [`docs/ref/`](docs/ref/) for full reference material:

- [Tax rules and ACB formulas](docs/ref/crypto-tax-reference-quebec-2025.md)
- [Database schema](docs/ref/database-schema.md)
- [Data pipeline](docs/ref/data-pipeline.mermaid)
- [TUI design and keyboard bindings](docs/ref/tui-design-guidelines.md)
- [Bitcoin node verification](docs/ref/bitcoin-node-validation-module.md)
- [Language guide and CLI verbs](docs/ref/sirop-language-guide.md)

## License

MIT — see [LICENSE](LICENSE).

