beanhub-cli 3.0.0b2__tar.gz → 3.1.0__tar.gz

{beanhub_cli-3.0.0b2 → beanhub_cli-3.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: beanhub-cli
-Version: 3.0.0b2
+Version: 3.1.0
 Summary: Command line tools for BeanHub and Beancount users
 Project-URL: Documentation, https://beanhub-cli-docs.beanhub.io
 Author-email: Fang-Pen Lin <fangpen@launchplatform.com>
@@ -9,16 +9,20 @@ License-File: LICENSE
 Requires-Python: ~=3.10
 Requires-Dist: attrs>=22.2.0
 Requires-Dist: beancount-black<2,>=1.0.1
+Requires-Dist: beancount-data>=3.0.2
+Requires-Dist: beancount-exporter>=3.0.0
 Requires-Dist: beancount-parser<1.3.0,>=1.2.3
 Requires-Dist: beanhub-extract<1.0.0,>=0.1.0
 Requires-Dist: beanhub-forms<0.2,>=0.1.3
 Requires-Dist: beanhub-import<2.0.0,>=1.0.0
-Requires-Dist: beanhub-inbox<0.3.0,>=0.2.1
+Requires-Dist: beanhub-inbox<0.3.0,>=0.2.3
 Requires-Dist: click<9,>=8.1.7
-Requires-Dist: cryptography<45,>=44.0.0
+Requires-Dist: cryptography>=44.0.0
+Requires-Dist: fastapi-mcp>=0.3.7
 Requires-Dist: fastapi<1.0.0,>=0.98.0
 Requires-Dist: httpx<0.29.0,>=0.20.0
 Requires-Dist: jinja2<4.0.0,>=3.1.2
+Requires-Dist: orjson>=3.11.0
 Requires-Dist: pydantic-settings<3,>=2.0.3
 Requires-Dist: pydantic<3,>=2.4.0
 Requires-Dist: pynacl<2,>=1.5.0
@@ -43,10 +47,14 @@ Please read the [documentation here](https://beanhub-cli-docs.beanhub.io).
 - [**Formatter**](https://beanhub-cli-docs.beanhub.io/commands/format/) - Advanced Beancount file formatter based on top of [beancount-black](https://github.com/LaunchPlatform/beancount-black)
 - [**Beancount file manipulations**](https://beanhub-cli-docs.beanhub.io/commands/format/) - Effortless Beancount account name renaming and other basic manipulations
 - [**Forms**](https://beanhub-cli-docs.beanhub.io/commands/form/) - You can run a [BeanHub Form](https://beanhub.io/blog/2023/07/31/automating-beancount-data-input-with-beanhub-custom-forms/) web app locally to try out your forms
+- [**Inbox**](https://github.com/LaunchPlatform/beanhub-inbox) - Archive emails sending to a dedicated email address like yourname+repo@inbox.beanhub.io (BeanHub account needed) and then use LLM to extract values for your invoices and receipts
 - **Doesn't require a BeanHub account** - While some features require a BeanHub account to operate, but we make most of them usable even without a BeanHub account
 
 ## Screenshots
 
+<p align="center">
+  <video src="https://github.com/user-attachments/assets/eb496dab-cd95-4aca-8a29-89ff9d52570d" autoplay muted>
+</p>
 <p align="center">
   <img src="https://github.com/LaunchPlatform/beanhub-cli/raw/master/assets/forms-screenshot.png?raw=true" alt="BeanHub Forms Screenshot" />
 </p>

{beanhub_cli-3.0.0b2 → beanhub_cli-3.1.0}/README.md

@@ -10,10 +10,14 @@ Please read the [documentation here](https://beanhub-cli-docs.beanhub.io).
 - [**Formatter**](https://beanhub-cli-docs.beanhub.io/commands/format/) - Advanced Beancount file formatter based on top of [beancount-black](https://github.com/LaunchPlatform/beancount-black)
 - [**Beancount file manipulations**](https://beanhub-cli-docs.beanhub.io/commands/format/) - Effortless Beancount account name renaming and other basic manipulations
 - [**Forms**](https://beanhub-cli-docs.beanhub.io/commands/form/) - You can run a [BeanHub Form](https://beanhub.io/blog/2023/07/31/automating-beancount-data-input-with-beanhub-custom-forms/) web app locally to try out your forms
+- [**Inbox**](https://github.com/LaunchPlatform/beanhub-inbox) - Archive emails sending to a dedicated email address like yourname+repo@inbox.beanhub.io (BeanHub account needed) and then use LLM to extract values for your invoices and receipts
 - **Doesn't require a BeanHub account** - While some features require a BeanHub account to operate, but we make most of them usable even without a BeanHub account
 
 ## Screenshots
 
+<p align="center">
+  <video src="https://github.com/user-attachments/assets/eb496dab-cd95-4aca-8a29-89ff9d52570d" autoplay muted>
+</p>
 <p align="center">
   <img src="https://github.com/LaunchPlatform/beanhub-cli/raw/master/assets/forms-screenshot.png?raw=true" alt="BeanHub Forms Screenshot" />
 </p>

{beanhub_cli-3.0.0b2 → beanhub_cli-3.1.0}/beanhub_cli/format.py

@@ -1,5 +1,6 @@
 import copy
 import functools
+import logging
 import pathlib
 import shutil
 import sys
@@ -115,54 +116,26 @@ def combine_transforms(
     return tree_or_token
 
 
-@cli.command(name="format", help="Format Beancount files with beancount-black")
-@click.argument("filename", type=click.Path(exists=False, dir_okay=False), nargs=-1)
-@click.option(
-    "--backup-suffix", type=str, default=".backup", help="suffix of backup file"
-)
-@click.option(
-    "-ra",
-    "--rename-account",
-    type=(str, str),
-    help="rename account names",
-    nargs=2,
-    multiple=True,
-)
-@click.option(
-    "-rc",
-    "--rename-currency",
-    type=(str, str),
-    help="rename currency names",
-    nargs=2,
-    multiple=True,
-)
-@click.option(
-    "-s",
-    "--stdin-mode",
-    is_flag=True,
-    help="Read beancount file data from stdin and output result to stdout",
-)
-@click.option("-b", "--backup", is_flag=True, help="Create backup file")
-@pass_env
-def main(
-    env: Environment,
-    filename: list[click.Path],
-    backup_suffix: str,
-    rename_account: list[tuple[str, str]],
-    rename_currency: list[tuple[str, str]],
-    stdin_mode: bool,
-    backup: bool,
+def format_beancount(
+    filenames: list[pathlib.Path],
+    backup_suffix: str = ".backup",
+    rename_account: list[tuple[str, str]] | None = None,
+    rename_currency: list[tuple[str, str]] | None = None,
+    stdin_mode: bool = False,
+    backup: bool = False,
+    logger: logging.Logger | None = None,
 ):
+    logger = logger or logging.getLogger(__name__)
     tree_transformers: list[typing.Callable] = []
     if rename_account:
         for from_val, to_val in rename_account:
-            env.logger.info("Renaming account from %s to %s", from_val, to_val)
+            logger.info("Renaming account from %s to %s", from_val, to_val)
         tree_transformers.append(
             functools.partial(rename_account_transform, dict(rename_account))
         )
     if rename_currency:
         for from_val, to_val in rename_currency:
-            env.logger.info("Renaming currency from %s to %s", from_val, to_val)
+            logger.info("Renaming currency from %s to %s", from_val, to_val)
         tree_transformers.append(
             functools.partial(rename_commodity_transform, dict(rename_currency))
         )
@@ -170,28 +143,28 @@ def main(
     # TODO: support follow include statements
     parser = make_parser()
     if stdin_mode:
-        env.logger.info("Processing in stdin mode")
+        logger.info("Processing in stdin mode")
         input_content = sys.stdin.read()
         tree = parser.parse(input_content)
         formatter = Formatter()
         formatter.format(tree, sys.stdout)
     else:
-        if filename:
+        if filenames:
             iterator = file_tree_iterator(
                 parser=parser,
-                filenames=map(lambda item: pathlib.Path(str(item)), filename),
+                filenames=filenames,
             )
         else:
-            env.logger.info("No files provided, traverse starting from main.bean")
+            logger.info("No files provided, traverse starting from main.bean")
             iterator = traverse(
                 parser=parser,
                 bean_file=pathlib.Path("main.bean"),
                 root_dir=pathlib.Path.cwd(),
             )
         for filepath, tree in iterator:
-            env.logger.info("Processing file %s", filepath)
+            logger.info("Processing file %s", filepath)
             if tree_transformers:
-                env.logger.info(
+                logger.info(
                     "Running %s transforms against file %s ...",
                     len(tree_transformers),
                     filepath,
@@ -207,14 +180,61 @@ def main(
                 output_content = output_file.read()
                 input_content = filepath.read_text()
                 if input_content == output_content:
-                    env.logger.info("File %s is not changed, skip", filepath)
+                    logger.info("File %s is not changed, skip", filepath)
                     continue
                 if backup:
                     backup_path = create_backup(src=filepath, suffix=backup_suffix)
-                    env.logger.info(
-                        "File %s changed, backup to %s", filepath, backup_path
-                    )
+                    logger.info("File %s changed, backup to %s", filepath, backup_path)
                 output_file.seek(0)
                 with open(filepath, "wt") as input_file:
                     shutil.copyfileobj(output_file, input_file)
-    env.logger.info("done")
+    logger.info("done")
+
+
+@cli.command(name="format", help="Format Beancount files with beancount-black")
+@click.argument("filename", type=click.Path(exists=False, dir_okay=False), nargs=-1)
+@click.option(
+    "--backup-suffix", type=str, default=".backup", help="suffix of backup file"
+)
+@click.option(
+    "-ra",
+    "--rename-account",
+    type=(str, str),
+    help="rename account names",
+    nargs=2,
+    multiple=True,
+)
+@click.option(
+    "-rc",
+    "--rename-currency",
+    type=(str, str),
+    help="rename currency names",
+    nargs=2,
+    multiple=True,
+)
+@click.option(
+    "-s",
+    "--stdin-mode",
+    is_flag=True,
+    help="Read beancount file data from stdin and output result to stdout",
+)
+@click.option("-b", "--backup", is_flag=True, help="Create backup file")
+@pass_env
+def main(
+    env: Environment,
+    filename: list[click.Path],
+    backup_suffix: str,
+    rename_account: list[tuple[str, str]],
+    rename_currency: list[tuple[str, str]],
+    stdin_mode: bool,
+    backup: bool,
+):
+    format_beancount(
+        filenames=list(map(lambda item: pathlib.Path(str(item)), filename)),
+        backup_suffix=backup_suffix,
+        rename_account=rename_account,
+        rename_currency=rename_currency,
+        stdin_mode=stdin_mode,
+        backup=backup,
+        logger=env.logger,
+    )

{beanhub_cli-3.0.0b2 → beanhub_cli-3.1.0}/beanhub_cli/main.py

@@ -5,6 +5,7 @@ from .forms import main as forms  # noqa
 from .import_cli import main as import_cli  # noqa
 from .inbox import main as inbox  # noqa
 from .login import main as login  # noqa
+from .mcp import main as mcp  # noqa
 
 __ALL__ = [cli]
 

beanhub_cli-3.1.0/beanhub_cli/mcp/app/main.py

@@ -0,0 +1,16 @@
+from fastapi import FastAPI
+from fastapi_mcp import FastApiMCP
+
+from .routes import router
+
+
+def make_app() -> FastAPI:
+    app = FastAPI(
+        openapi_url="",
+        docs_url=None,
+        redoc_url=None,
+    )
+    app.include_router(router)
+    mcp = FastApiMCP(app)
+    mcp.mount()
+    return app

beanhub_cli-3.1.0/beanhub_cli/mcp/app/routes.py

@@ -0,0 +1,62 @@
+import json
+import logging
+import pathlib
+import subprocess
+import sys
+
+from beancount_data.data_types import EntryUnion
+from beancount_data.data_types import ValidationResult
+from fastapi import APIRouter
+from fastapi import Request
+from pydantic import TypeAdapter
+
+from ...format import format_beancount
+from ..schemes import ExportBeancountResult
+from ..schemes import FormatResult
+
+router = APIRouter()
+logger = logging.getLogger(__name__)
+entry_adapter = TypeAdapter(EntryUnion)
+
+
+@router.get(
+    "/entries",
+    response_model=ExportBeancountResult,
+    operation_id="list-entries",
+    description="List all Beancount entries for the given Beancount file",
+)
+async def list_entries(
+    request: Request, beancount_file: str = "main.bean"
+) -> ExportBeancountResult:
+    proc = subprocess.run(
+        (sys.executable, "-m", "beancount_exporter.main", beancount_file),
+        timeout=10,
+        capture_output=True,
+    )
+    lines = proc.stdout.splitlines()
+    result = ExportBeancountResult(
+        ok=proc.returncode == 0,
+        error=proc.stderr.decode("utf8"),
+    )
+    if proc.returncode == 0:
+        result.options = json.loads(lines[0])
+        result.validation_result = ValidationResult.model_validate_json(lines[2])
+        result.entries = list(map(entry_adapter.validate_json, lines[4:]))
+    else:
+        logger.error("Failed to export entries: %s", result.error)
+    return result
+
+
+@router.get(
+    "/format",
+    response_model=FormatResult,
+    operation_id="format-beancount-file",
+    description="Format beancount files",
+)
+async def format_beancount_file(
+    request: Request, beancount_file: str = "main.bean"
+) -> FormatResult:
+    format_beancount(filenames=[pathlib.Path(beancount_file)])
+    return FormatResult(
+        ok=True,
+    )

beanhub_cli-3.1.0/beanhub_cli/mcp/cli.py

@@ -0,0 +1,10 @@
+from ..aliase import AliasedGroup
+from ..cli import cli as root_cli
+
+
+@root_cli.group(
+    name="mcp",
+    help="Run Model Context Protocol (MCP) server for LLM to access your Beancount books",
+)
+def cli():
+    pass

beanhub_cli-3.1.0/beanhub_cli/mcp/main.py

@@ -0,0 +1,38 @@
+import click
+import uvicorn
+
+from ..environment import Environment
+from ..environment import pass_env
+from .app.main import make_app
+from .cli import cli
+
+
+@cli.command(name="server", help="Run a web server for the MCP service")
+@click.option(
+    "-p",
+    "--port",
+    type=int,
+    default=8080,
+    show_default=True,
+    help="Port number for serving the MCP web app.",
+)
+@click.option(
+    "-h",
+    "--host",
+    type=str,
+    default="127.0.0.1",
+    show_default=True,
+    help="Host for serving the MCP web app.",
+)
+@click.option(
+    "--uvicorn-log-level",
+    default="info",
+    show_default=True,
+    help="Log level for Uvicorn web server.",
+)
+@pass_env
+def run_server(env: Environment, port: int, host: str, uvicorn_log_level: str):
+    app = make_app()
+    config = uvicorn.Config(app=app, port=port, host=host, log_level=uvicorn_log_level)
+    server = uvicorn.Server(config=config)
+    server.run()

beanhub_cli-3.1.0/beanhub_cli/mcp/schemes.py

@@ -0,0 +1,20 @@
+import typing
+
+from beancount_data.data_types import EntryUnion
+from beancount_data.data_types import ValidationResult
+from pydantic import BaseModel
+
+
+class ResultBase(BaseModel):
+    ok: bool
+    error: typing.Optional[str] = None
+
+
+class ExportBeancountResult(ResultBase):
+    options: typing.Optional[typing.Dict[str, typing.Any]] = None
+    validation_result: typing.Optional[ValidationResult] = None
+    entries: typing.Optional[EntryUnion] = None
+
+
+class FormatResult(ResultBase):
+    pass

{beanhub_cli-3.0.0b2 → beanhub_cli-3.1.0}/docs/docs/commands/connect.md

@@ -10,13 +10,6 @@ Originally, this feature imports data as Git commits only to BeanHub's repositor
 Later on, we added the standalone commands to make it possible to pull bank transactions directly into your local work environment without relying on updates in BeanHub's Git repository.
 You can read our blog post [Direct Connect: Pulling transactions as CSV files from banks via Plaid directly](https://beanhub.io/blog/2025/01/16/direct-connect-repository/) to learn more.
 
-Please note that connect commands require some extra optional Python dependencies.
-Therefore, when installing BeanHub-CLI Python package, please make sure to include `connect` extra dependencies like this:
-
-```bash
-pip install "beanhub-cli[connect]"
-```
-
 ## Pre-requirements
 
 To pull transaction data from your bank automatically, you need to first log into your BeanHub account on our web app and then go to your repository.

{beanhub_cli-3.0.0b2 → beanhub_cli-3.1.0}/docs/docs/commands/login.md

@@ -4,13 +4,6 @@ We provide BeanHub-CLI as a standalone tool to work without a [BeanHub](https://
 However, some features are for paid BeanHub members only and require access to your BeanHub account, such as [BeanHub Connect](https://beanhub.io/blog/2024/06/24/introduction-of-beanhub-connect/)'s sync and dump.
 For those operations, you need to run the login command first.
 
-Please note that BeanHub-CLI login command requires some extra optional Python dependencies.
-Therefore, when installing BeanHub-CLI Python package, please make sure to include `login` extra dependencies like this:
-
-```bash
-pip install "beanhub-cli[login]"
-```
-
 It's very easy to log in to your BeanHub account with BeanHub-CLI. Simply run:
 
 ```bash

{beanhub_cli-3.0.0b2 → beanhub_cli-3.1.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "beanhub-cli"
-version = "3.0.0b2"
+version = "3.1.0"
 description = "Command line tools for BeanHub and Beancount users"
 authors = [{ name = "Fang-Pen Lin", email = "fangpen@launchplatform.com" }]
 requires-python = "~=3.10"
@@ -24,11 +24,15 @@ dependencies = [
     "tomli>=2.2.1,<3",
     "tomli-w>=1.1.0,<2",
     "pynacl>=1.5.0,<2",
-    "cryptography>=44.0.0,<45",
     "beanhub-import>= 1.0.0, <2.0.0",
     "beanhub-extract>= 0.1.0, <1.0.0",
     "beancount-parser>= 1.2.3, <1.3.0",
-    "beanhub-inbox>=0.2.1, <0.3.0",
+    "beanhub-inbox>=0.2.3,<0.3.0",
+    "cryptography>=44.0.0",
+    "fastapi-mcp>=0.3.7",
+    "beancount-data>=3.0.2",
+    "beancount-exporter>=3.0.0",
+    "orjson>=3.11.0",
 ]
 
 [project.urls]