beancount-tools-collection 1.0.0__tar.gz

beancount_tools_collection-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Beancount Tools Collection Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

beancount_tools_collection-1.0.0/PKG-INFO

@@ -0,0 +1,275 @@
+Metadata-Version: 2.4
+Name: beancount-tools-collection
+Version: 1.0.0
+Summary: A comprehensive collection of beancount tools: importers, price fetchers, plugins, and utilities
+Author-email: Alexandre Joly <alexandre.joly@mekanics.ch>
+License: MIT
+Project-URL: Homepage, https://github.com/mekanics/beancount-tools-collection
+Project-URL: Repository, https://github.com/mekanics/beancount-tools-collection
+Project-URL: Documentation, https://github.com/mekanics/beancount-tools-collection#readme
+Project-URL: Bug Tracker, https://github.com/mekanics/beancount-tools-collection/issues
+Keywords: beancount,accounting,finance,importers,prices,plugins,tools,banks,trading,investment
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Office/Business :: Financial :: Accounting
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: beancount>=3.1.0
+Requires-Dist: beangulp>=0.2.0
+Requires-Dist: pandas>=1.3.0
+Requires-Dist: python-dateutil>=2.8.0
+Requires-Dist: loguru>=0.7.3
+Requires-Dist: pyyaml>=5.4.0
+Requires-Dist: ibflex>=0.15
+Requires-Dist: requests>=2.32.4
+Requires-Dist: beanquery>=0.2.0
+Provides-Extra: dev
+Requires-Dist: pytest>=6.0; extra == "dev"
+Requires-Dist: pytest-cov>=2.12; extra == "dev"
+Requires-Dist: black>=21.0; extra == "dev"
+Requires-Dist: isort>=5.9; extra == "dev"
+Requires-Dist: flake8>=3.9; extra == "dev"
+Requires-Dist: mypy>=0.910; extra == "dev"
+Requires-Dist: beangulp; extra == "dev"
+Requires-Dist: beancount; extra == "dev"
+Provides-Extra: test
+Requires-Dist: pytest>=6.0; extra == "test"
+Requires-Dist: pytest-cov>=2.12; extra == "test"
+Dynamic: license-file
+
+# Beancount Tools Collection
+
+🧮 My personal collection of beancount tools including importers, price fetchers, plugins, and utilities for various financial institutions.
+
+[![Python 3.9+](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![GitHub issues](https://img.shields.io/github/issues/mekanics/beancount-tools-collection)](https://github.com/mekanics/beancount-tools-collection/issues)
+
+## Features
+
+### 📥 Data Importers
+
+**Swiss Institutions:**
+
+- **Yuh** - CSV exports
+- **Viseca** - JSON transaction exports (including Migros Cumulus Credit Card)
+- **VIAC** - JSON transaction exports (pillar 2 & 3a)
+- **Finpension** - CSV transaction reports (pillar 3a)
+
+**International Institutions:**
+
+- **Interactive Brokers** - FlexQuery XML reports (global)
+- **Revolut** - CSV exports (multi-country)
+
+**Other Formats:**
+
+- **Firefly III** - CSV exports
+
+### 💰 Price Fetchers
+
+- **Interactive Brokers** - Real-time prices from FlexQuery
+
+### 🔌 Beancount Plugins
+
+- _Crickets chirping_ 🦗 - This section is as empty as my wallet after buying crypto at the peak
+
+### 🛠️ Utility Scripts
+
+- **Transaction Processor** - Example transaction processing with ImporterProtocolAdapter and TransactionInspector for automatic categorization and payee standardization
+
+## Installation
+
+### From PyPI
+
+```bash
+pip install beancount-tools-collection
+```
+
+### From Source
+
+```bash
+git clone https://github.com/mekanics/beancount-tools-collection.git
+cd beancount-tools-collection
+pip install -e .
+```
+
+## Quick Start
+
+### Basic Importer Configuration
+
+```python
+from beancount_tools_collection.importers import (
+    finpension, ibkr, revolut,
+    viac, viseca, yuh
+)
+
+# Example configuration
+CONFIG = [
+    # Swiss institutions
+    finpension.FinpensionImporter(
+        root_account="Assets:Pension:S3:Finpension:Portfolio1",
+        deposit_account="Assets:Checking",
+        isin_lookup={
+            "CH0132501898": "CH0132501898",  # Example ISIN mapping
+            # ... more ISINs
+        }
+    ),
+
+    viac.ViacImporter(
+        root_account="Assets:Pension:S3a:Viac:Portfolio1",
+        deposit_account="Assets:Checking",
+        share_lookup={
+            "UBS SMI": {"isin": "CH0033782431", "symbol": "CH0033782431"},
+            # ... more share mappings
+        }
+    ),
+
+    yuh.YuhImporter(
+        account="Assets:Cash:Yuh:CHF",
+        goals_base_account="Assets:Savings:Yuh"
+    ),
+
+    # International institutions
+    ibkr.IBKRImporter(
+        Mainaccount="Assets:Invest:InteractiveBrokers",
+        DivAccount="Income:Dividends:InteractiveBrokers",
+        WHTAccount="Expenses:Taxes:WithholdingTax",
+        PnLAccount="Income:Invest:Gains",
+        FeesAccount="Expenses:Invest:Fees",
+        configFile="ibkr.yaml"  # Your IBKR FlexQuery config
+    ),
+
+    revolut.RevolutImporter(
+        "revolut_chf",
+        "Assets:Cash:Revolut:CHF",
+        "CHF"
+    ),
+]
+```
+
+### Price Fetcher Configuration
+
+```python
+# In your beancount price configuration
+from beancount_tools_collection.prices import ibkr
+
+# The IBKR price source will be available for bean-price
+```
+
+## Documentation
+
+### Importer-Specific Setup
+
+Each importer has specific requirements and configuration options:
+
+- **[Finpension](docs/importers/finpension.md)** - CSV transaction reports
+- **[Interactive Brokers](docs/importers/ibkr.md)** - FlexQuery configuration
+- **[VIAC](docs/importers/viac.md)** - JSON export setup
+- **[Yuh](docs/importers/yuh.md)** - CSV export configuration
+
+### Account Structure Examples
+
+The importers work best with structured account hierarchies:
+
+```
+Assets:
+  Cash:
+    Yuh:
+      CHF
+      USD
+    Revolut:
+      CHF
+      EUR
+  Invest:
+    InteractiveBrokers:
+      Long-Term:
+        VTI
+        VXUS
+        USD
+  Pension:
+    S3a:
+      Finpension:
+        Portfolio1:
+          CHF
+      Viac:
+        Portfolio1:
+          CH0132501898
+
+Income:
+  Dividends:
+    InteractiveBrokers:
+      Long-Term:
+        USD
+  Pension:
+    S3a:
+      Finpension:
+        Portfolio1:
+          Interest:
+            CHF
+
+Expenses:
+  Invest:
+    Fees:
+      CHF
+      USD
+  Taxes:
+    WithholdingTax
+```
+
+## Contributing
+
+We welcome contributions! Here's how you can help:
+
+1. **Add new importers** for financial institutions
+2. **Improve existing importers** with bug fixes and features
+3. **Add price fetchers** for different data sources
+4. **Create plugins** for common beancount workflows
+5. **Improve documentation** and examples
+
+### Development Setup
+
+```bash
+git clone https://github.com/mekanics/beancount-tools-collection.git
+cd beancount-tools-collection
+pip install -e ".[dev]"
+```
+
+### Running Tests
+
+```bash
+pytest
+```
+
+### Code Formatting
+
+```bash
+black src/
+isort src/
+```
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Acknowledgments
+
+- The [beancount](https://github.com/beancount/beancount) project for the excellent accounting framework
+- Various open-source beancount importers that served as inspiration
+
+## Support
+
+- 📖 [Documentation](https://github.com/mekanics/beancount-tools-collection#readme)
+- 🐛 [Bug Reports](https://github.com/mekanics/beancount-tools-collection/issues)
+- 💬 [Discussions](https://github.com/mekanics/beancount-tools-collection/discussions)
+
+---
+
+**Made with ❤️ for personal finance tracking**

beancount_tools_collection-1.0.0/README.md

@@ -0,0 +1,228 @@
+# Beancount Tools Collection
+
+🧮 My personal collection of beancount tools including importers, price fetchers, plugins, and utilities for various financial institutions.
+
+[![Python 3.9+](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![GitHub issues](https://img.shields.io/github/issues/mekanics/beancount-tools-collection)](https://github.com/mekanics/beancount-tools-collection/issues)
+
+## Features
+
+### 📥 Data Importers
+
+**Swiss Institutions:**
+
+- **Yuh** - CSV exports
+- **Viseca** - JSON transaction exports (including Migros Cumulus Credit Card)
+- **VIAC** - JSON transaction exports (pillar 2 & 3a)
+- **Finpension** - CSV transaction reports (pillar 3a)
+
+**International Institutions:**
+
+- **Interactive Brokers** - FlexQuery XML reports (global)
+- **Revolut** - CSV exports (multi-country)
+
+**Other Formats:**
+
+- **Firefly III** - CSV exports
+
+### 💰 Price Fetchers
+
+- **Interactive Brokers** - Real-time prices from FlexQuery
+
+### 🔌 Beancount Plugins
+
+- _Crickets chirping_ 🦗 - This section is as empty as my wallet after buying crypto at the peak
+
+### 🛠️ Utility Scripts
+
+- **Transaction Processor** - Example transaction processing with ImporterProtocolAdapter and TransactionInspector for automatic categorization and payee standardization
+
+## Installation
+
+### From PyPI
+
+```bash
+pip install beancount-tools-collection
+```
+
+### From Source
+
+```bash
+git clone https://github.com/mekanics/beancount-tools-collection.git
+cd beancount-tools-collection
+pip install -e .
+```
+
+## Quick Start
+
+### Basic Importer Configuration
+
+```python
+from beancount_tools_collection.importers import (
+    finpension, ibkr, revolut,
+    viac, viseca, yuh
+)
+
+# Example configuration
+CONFIG = [
+    # Swiss institutions
+    finpension.FinpensionImporter(
+        root_account="Assets:Pension:S3:Finpension:Portfolio1",
+        deposit_account="Assets:Checking",
+        isin_lookup={
+            "CH0132501898": "CH0132501898",  # Example ISIN mapping
+            # ... more ISINs
+        }
+    ),
+
+    viac.ViacImporter(
+        root_account="Assets:Pension:S3a:Viac:Portfolio1",
+        deposit_account="Assets:Checking",
+        share_lookup={
+            "UBS SMI": {"isin": "CH0033782431", "symbol": "CH0033782431"},
+            # ... more share mappings
+        }
+    ),
+
+    yuh.YuhImporter(
+        account="Assets:Cash:Yuh:CHF",
+        goals_base_account="Assets:Savings:Yuh"
+    ),
+
+    # International institutions
+    ibkr.IBKRImporter(
+        Mainaccount="Assets:Invest:InteractiveBrokers",
+        DivAccount="Income:Dividends:InteractiveBrokers",
+        WHTAccount="Expenses:Taxes:WithholdingTax",
+        PnLAccount="Income:Invest:Gains",
+        FeesAccount="Expenses:Invest:Fees",
+        configFile="ibkr.yaml"  # Your IBKR FlexQuery config
+    ),
+
+    revolut.RevolutImporter(
+        "revolut_chf",
+        "Assets:Cash:Revolut:CHF",
+        "CHF"
+    ),
+]
+```
+
+### Price Fetcher Configuration
+
+```python
+# In your beancount price configuration
+from beancount_tools_collection.prices import ibkr
+
+# The IBKR price source will be available for bean-price
+```
+
+## Documentation
+
+### Importer-Specific Setup
+
+Each importer has specific requirements and configuration options:
+
+- **[Finpension](docs/importers/finpension.md)** - CSV transaction reports
+- **[Interactive Brokers](docs/importers/ibkr.md)** - FlexQuery configuration
+- **[VIAC](docs/importers/viac.md)** - JSON export setup
+- **[Yuh](docs/importers/yuh.md)** - CSV export configuration
+
+### Account Structure Examples
+
+The importers work best with structured account hierarchies:
+
+```
+Assets:
+  Cash:
+    Yuh:
+      CHF
+      USD
+    Revolut:
+      CHF
+      EUR
+  Invest:
+    InteractiveBrokers:
+      Long-Term:
+        VTI
+        VXUS
+        USD
+  Pension:
+    S3a:
+      Finpension:
+        Portfolio1:
+          CHF
+      Viac:
+        Portfolio1:
+          CH0132501898
+
+Income:
+  Dividends:
+    InteractiveBrokers:
+      Long-Term:
+        USD
+  Pension:
+    S3a:
+      Finpension:
+        Portfolio1:
+          Interest:
+            CHF
+
+Expenses:
+  Invest:
+    Fees:
+      CHF
+      USD
+  Taxes:
+    WithholdingTax
+```
+
+## Contributing
+
+We welcome contributions! Here's how you can help:
+
+1. **Add new importers** for financial institutions
+2. **Improve existing importers** with bug fixes and features
+3. **Add price fetchers** for different data sources
+4. **Create plugins** for common beancount workflows
+5. **Improve documentation** and examples
+
+### Development Setup
+
+```bash
+git clone https://github.com/mekanics/beancount-tools-collection.git
+cd beancount-tools-collection
+pip install -e ".[dev]"
+```
+
+### Running Tests
+
+```bash
+pytest
+```
+
+### Code Formatting
+
+```bash
+black src/
+isort src/
+```
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Acknowledgments
+
+- The [beancount](https://github.com/beancount/beancount) project for the excellent accounting framework
+- Various open-source beancount importers that served as inspiration
+
+## Support
+
+- 📖 [Documentation](https://github.com/mekanics/beancount-tools-collection#readme)
+- 🐛 [Bug Reports](https://github.com/mekanics/beancount-tools-collection/issues)
+- 💬 [Discussions](https://github.com/mekanics/beancount-tools-collection/discussions)
+
+---
+
+**Made with ❤️ for personal finance tracking**

beancount_tools_collection-1.0.0/pyproject.toml

@@ -0,0 +1,71 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "beancount-tools-collection"
+version = "1.0.0"
+description = "A comprehensive collection of beancount tools: importers, price fetchers, plugins, and utilities"
+readme = "README.md"
+license = {text = "MIT"}
+authors = [
+    {name = "Alexandre Joly", email = "alexandre.joly@mekanics.ch"}
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: End Users/Desktop",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Office/Business :: Financial :: Accounting",
+]
+keywords = ["beancount", "accounting", "finance", "importers", "prices", "plugins", "tools", "banks", "trading", "investment"]
+requires-python = ">=3.9"
+dependencies = [
+    "beancount>=3.1.0",
+    "beangulp>=0.2.0",
+    "pandas>=1.3.0",
+    "python-dateutil>=2.8.0",
+    "loguru>=0.7.3",
+    "pyyaml>=5.4.0",
+    "ibflex>=0.15", # for IBKR importer
+    "requests>=2.32.4", # for price fetchers
+    "beanquery>=0.2.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=6.0",
+    "pytest-cov>=2.12",
+    "black>=21.0",
+    "isort>=5.9",
+    "flake8>=3.9",
+    "mypy>=0.910",
+    "beangulp",
+    "beancount"
+]
+test = [
+    "pytest>=6.0",
+    "pytest-cov>=2.12",
+]
+
+[project.urls]
+Homepage = "https://github.com/mekanics/beancount-tools-collection"
+Repository = "https://github.com/mekanics/beancount-tools-collection"
+Documentation = "https://github.com/mekanics/beancount-tools-collection#readme"
+"Bug Tracker" = "https://github.com/mekanics/beancount-tools-collection/issues"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.black]
+line-length = 88
+target-version = ['py39']
+
+[tool.isort]
+profile = "black"
+line_length = 88 

beancount_tools_collection-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

beancount_tools_collection-1.0.0/src/beancount_tools_collection/__init__.py

@@ -0,0 +1,18 @@
+"""
+Beancount Tools Collection
+
+A comprehensive collection of beancount tools including importers, price fetchers, 
+plugins, and utilities for financial institutions worldwide.
+"""
+
+__version__ = "1.0.0"
+__author__ = "Beancount Tools Collection Contributors"
+
+# Make main modules easily accessible
+from . import importers
+from . import prices
+from . import plugins
+from . import scripts
+from . import utils
+
+__all__ = ["importers", "prices", "plugins", "scripts", "utils"] 

beancount_tools_collection-1.0.0/src/beancount_tools_collection/importers/__init__.py

@@ -0,0 +1,58 @@
+"""
+Beancount importers for various financial institutions.
+
+This module contains importers for Swiss and international financial institutions.
+"""
+
+# Import all available importers
+
+
+try:
+    from . import finpension
+except ImportError:
+    finpension = None
+
+try:
+    from . import ibkr
+except ImportError:
+    ibkr = None
+
+try:
+    from . import revolut
+except ImportError:
+    revolut = None
+
+
+
+try:
+    from . import viac
+except ImportError:
+    viac = None
+
+try:
+    from . import viseca
+except ImportError:
+    viseca = None
+
+try:
+    from . import yuh
+except ImportError:
+    yuh = None
+
+
+
+try:
+    from . import firefly_iii
+except ImportError:
+    firefly_iii = None
+
+# List of available importers (only those that imported successfully)
+__all__ = [name for name, module in locals().items() 
+           if module is not None and not name.startswith('_')]
+
+# Metadata
+SUPPORTED_INSTITUTIONS = {
+    'swiss': ['finpension', 'viac', 'viseca', 'yuh'],
+    'international': ['ibkr', 'revolut'],
+    'other': ['firefly_iii']
+}