beanhub-cli 1.1.0__tar.gz → 1.1.2__tar.gz

{beanhub_cli-1.1.0 → beanhub_cli-1.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: beanhub-cli
-Version: 1.1.0
+Version: 1.1.2
 Summary: Command line tools for BeanHub
 License: MIT
 Author: Fang-Pen Lin
@@ -12,8 +12,10 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Dist: beancount-black (>=1.0.1,<2.0.0)
+Requires-Dist: beancount-parser (>=1.2.3,<1.3.0)
+Requires-Dist: beanhub-extract (>=0.0.7,<0.1.0)
 Requires-Dist: beanhub-forms (>=0.1.3,<0.2.0)
-Requires-Dist: beanhub-import (>=0.0.4,<0.0.5)
+Requires-Dist: beanhub-import (>=0.1.3,<0.2.0)
 Requires-Dist: click (>=8.1.7,<9.0.0)
 Requires-Dist: fastapi (>=0.98.0,<1.0.0)
 Requires-Dist: jinja2 (>=3.1.2,<4.0.0)
@@ -31,6 +33,7 @@ Command line tools for BeanHub or Beancount users.
 ## Features
 
 - **Local BeanHub Form web app** - 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
+- **Import** - Simple yet powerful [beanhub-import](https://github.com/LaunchPlatform/beanhub-import) allows you to define importing rules in YAML to extract transactions from CSV files and generate Beancount transactions automatically
 - **Formatter** - Advanced Beancount file formatter based on top of [beancount-black](https://github.com/LaunchPlatform/beancount-black)
 - **Basic Beancount file manipulations** - Effortless Beancount account name renaming and other basic manipulations (coming soon)
 - **Doesn't require a BeanHub account** - While some features in the future will require a BeanHub repository to operate, but we make most of them usable even without a BeanHub account
@@ -56,6 +59,16 @@ pip install beanhub-cli
 ```
 ## Usage
 
+## BeanHub Import
+
+To run BeanHub's import feature locally, you can define your import rules at `.beanhub/imports.yaml` and then run the following command in your Beancount folder:
+
+```bash
+bh import
+```
+
+To learn more about the import document and how the BeanHub import feature works, you can read the README of [beanhub-import](https://github.com/LaunchPlatform/beanhub-import).
+
 ### BeanHub Forms web app
 
 To make it much easier for BeanHub users to test their BeanHub Forms locally, we added a simple local web app for that in beanhub-cli.

{beanhub_cli-1.1.0 → beanhub_cli-1.1.2}/README.md

@@ -4,6 +4,7 @@ Command line tools for BeanHub or Beancount users.
 ## Features
 
 - **Local BeanHub Form web app** - 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
+- **Import** - Simple yet powerful [beanhub-import](https://github.com/LaunchPlatform/beanhub-import) allows you to define importing rules in YAML to extract transactions from CSV files and generate Beancount transactions automatically
 - **Formatter** - Advanced Beancount file formatter based on top of [beancount-black](https://github.com/LaunchPlatform/beancount-black)
 - **Basic Beancount file manipulations** - Effortless Beancount account name renaming and other basic manipulations (coming soon)
 - **Doesn't require a BeanHub account** - While some features in the future will require a BeanHub repository to operate, but we make most of them usable even without a BeanHub account
@@ -29,6 +30,16 @@ pip install beanhub-cli
 ```
 ## Usage
 
+## BeanHub Import
+
+To run BeanHub's import feature locally, you can define your import rules at `.beanhub/imports.yaml` and then run the following command in your Beancount folder:
+
+```bash
+bh import
+```
+
+To learn more about the import document and how the BeanHub import feature works, you can read the README of [beanhub-import](https://github.com/LaunchPlatform/beanhub-import).
+
 ### BeanHub Forms web app
 
 To make it much easier for BeanHub users to test their BeanHub Forms locally, we added a simple local web app for that in beanhub-cli.

beanhub_cli-1.1.2/beanhub_cli/import_cli.py

@@ -0,0 +1,200 @@
+import pathlib
+import sys
+
+import click
+import rich
+import yaml
+from beancount_black.formatter import Formatter
+from beancount_parser.parser import make_parser
+from beanhub_extract.data_types import Transaction
+from beanhub_extract.utils import strip_base_path
+from beanhub_import.data_types import GeneratedTransaction
+from beanhub_import.data_types import ImportDoc
+from beanhub_import.post_processor import apply_change_set
+from beanhub_import.post_processor import compute_changes
+from beanhub_import.post_processor import extract_existing_transactions
+from beanhub_import.post_processor import txn_to_text
+from beanhub_import.processor import process_imports
+from rich import box
+from rich.markup import escape
+from rich.padding import Padding
+from rich.table import Table
+
+from .cli import cli
+from .environment import Environment
+from .environment import pass_env
+
+IMPORT_DOC_FILE = pathlib.Path(".beanhub") / "imports.yaml"
+TABLE_HEADER_STYLE = "yellow"
+TABLE_COLUMN_STYLE = "cyan"
+
+
+@cli.command(
+    name="import",
+    help="Import data into Beancount files based on the beanhub-import config file",
+)
+@click.option(
+    "-c",
+    "--config",
+    type=click.Path(exists=True, dir_okay=False),
+    default=".beanhub/imports.yaml",
+    help="The path to import config file",
+)
+@click.option(
+    "-w",
+    "--workdir",
+    type=click.Path(exists=True, dir_okay=True, file_okay=False),
+    default=str(pathlib.Path.cwd()),
+    help="The beanhub project path to work on",
+)
+@click.option(
+    "-b",
+    "--beanfile",
+    type=click.Path(exists=True, dir_okay=False, file_okay=True),
+    default="main.bean",
+    help="The path to main entry beancount file",
+)
+@pass_env
+def main(env: Environment, config: str, workdir: str, beanfile: str):
+    config_path = pathlib.Path(config)
+    with config_path.open("rt") as fo:
+        doc_payload = yaml.safe_load(fo)
+    import_doc = ImportDoc.model_validate(doc_payload)
+    workdir_path = pathlib.Path(workdir)
+    env.logger.info(
+        "Loaded import doc from [green]%s[/]",
+        config,
+        extra={"markup": True, "highlighter": None},
+    )
+
+    generated_txns: list[GeneratedTransaction] = []
+    unprocessed_txns: list[Transaction] = []
+    for txn in process_imports(import_doc=import_doc, input_dir=workdir_path):
+        if isinstance(txn, GeneratedTransaction):
+            generated_file_path = (workdir_path / txn.file).resolve()
+            env.logger.info(
+                "Generated transaction [green]%s[/] to file [green]%s[/]",
+                txn.id,
+                strip_base_path(workdir_path.resolve(), generated_file_path),
+                extra={"markup": True, "highlighter": None},
+            )
+            generated_txns.append(txn)
+        elif isinstance(txn, Transaction):
+            env.logger.info(
+                "Skipped input transaction at [green]%s[/]:[blue]%s[/]",
+                txn.file,
+                txn.lineno,
+                extra={"markup": True, "highlighter": None},
+            )
+            unprocessed_txns.append(txn)
+        else:
+            raise ValueError(f"Unexpected type {type(txn)}")
+    env.logger.info("Generated %s transactions", len(generated_txns))
+    env.logger.info("Skipped %s transactions", len(unprocessed_txns))
+
+    beanfile_path = (workdir_path / pathlib.Path(beanfile)).resolve()
+    if workdir_path.resolve().absolute() not in beanfile_path.absolute().parents:
+        env.logger.error(
+            "The provided beanfile path %s is not a sub-path of workdir %s",
+            beanfile_path,
+            workdir_path,
+        )
+        sys.exit(-1)
+
+    env.logger.info(
+        "Collecting existing imported transactions from Beancount books ..."
+    )
+    parser = make_parser()
+    existing_txns = list(
+        extract_existing_transactions(
+            parser=parser,
+            bean_file=beanfile_path,
+            root_dir=workdir_path,
+        )
+    )
+    env.logger.info(
+        "Found %s existing imported transactions in Beancount books", len(existing_txns)
+    )
+
+    formatter = Formatter()
+    change_sets = compute_changes(
+        generated_txns=generated_txns,
+        imported_txns=existing_txns,
+        work_dir=workdir_path,
+    )
+    for target_file, change_set in change_sets.items():
+        if not target_file.exists():
+            if change_set.remove or change_set.update:
+                raise ValueError("Expect new transactions to add only")
+            env.logger.info(
+                "Create new bean file %s with %s transactions",
+                target_file,
+                len(change_set.add),
+            )
+
+            bean_content = "\n\n".join(map(txn_to_text, change_set.add))
+            new_tree = parser.parse(bean_content)
+        else:
+            env.logger.info(
+                "Applying change sets (add=%s, update=%s, remove=%s) to %s",
+                len(change_set.add),
+                len(change_set.update),
+                len(change_set.remove),
+                target_file,
+            )
+            tree = parser.parse(target_file.read_text())
+            new_tree = apply_change_set(tree=tree, change_set=change_set)
+
+        with target_file.open("wt") as fo:
+            formatter.format(new_tree, fo)
+
+    table = Table(
+        title="Generated transactions",
+        box=box.SIMPLE,
+        header_style=TABLE_HEADER_STYLE,
+        expand=True,
+    )
+    # TODO: add src info
+    table.add_column("File", style=TABLE_COLUMN_STYLE)
+    table.add_column("Id", style=TABLE_COLUMN_STYLE)
+    table.add_column("Source", style=TABLE_COLUMN_STYLE)
+    table.add_column("Date", style=TABLE_COLUMN_STYLE)
+    table.add_column("Narration", style=TABLE_COLUMN_STYLE)
+    for txn in generated_txns:
+        table.add_row(
+            escape(str(txn.file)),
+            str(txn.id),
+            escape(str(":".join(txn.sources))),
+            escape(str(txn.date)),
+            escape(txn.narration),
+        )
+    rich.print(Padding(table, (1, 0, 0, 4)))
+
+    table = Table(
+        title="Unprocessed transactions",
+        box=box.SIMPLE,
+        header_style=TABLE_HEADER_STYLE,
+        expand=True,
+    )
+    table.add_column("File", style=TABLE_COLUMN_STYLE)
+    table.add_column("Line", style=TABLE_COLUMN_STYLE)
+    table.add_column("Extractor", style=TABLE_COLUMN_STYLE)
+    table.add_column("Date", style=TABLE_COLUMN_STYLE)
+    table.add_column("Desc", style=TABLE_COLUMN_STYLE)
+    table.add_column("Bank Desc", style=TABLE_COLUMN_STYLE)
+    table.add_column("Amount", style=TABLE_COLUMN_STYLE, justify="right")
+    table.add_column("Currency", style=TABLE_COLUMN_STYLE)
+    for txn in unprocessed_txns:
+        table.add_row(
+            escape(txn.file),
+            str(txn.lineno),
+            escape(str(txn.extractor)),
+            escape(str(txn.date)),
+            escape(txn.desc),
+            escape(txn.bank_desc),
+            escape(str(txn.amount)),
+            escape(txn.currency),
+        )
+    rich.print(Padding(table, (1, 0, 0, 4)))
+
+    env.logger.info("done")

{beanhub_cli-1.1.0 → beanhub_cli-1.1.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "beanhub-cli"
-version = "1.1.0"
+version = "1.1.2"
 description = "Command line tools for BeanHub"
 authors = ["Fang-Pen Lin <fangpen@launchplatform.com>"]
 license = "MIT"
@@ -22,7 +22,9 @@ uvicorn = "^0.23.2"
 beanhub-forms = "^0.1.3"
 pydantic-settings = "^2.0.3"
 rich = "^13.6.0"
-beanhub-import = "^0.0.4"
+beanhub-import = ">= 0.1.3, <0.2.0"
+beanhub-extract = ">= 0.0.7, <0.1.0"
+beancount-parser = ">= 1.2.3, <1.3.0"
 
 [tool.poetry.dev-dependencies]
 

beanhub_cli-1.1.0/beanhub_cli/import_cli.py

@@ -1,103 +0,0 @@
-import pathlib
-
-import click
-import yaml
-from beancount_black.formatter import Formatter
-from beancount_parser.parser import make_parser
-from beanhub_import.data_types import ImportDoc
-from beanhub_import.post_processor import apply_change_set
-from beanhub_import.post_processor import compute_changes
-from beanhub_import.post_processor import extract_imported_transactions
-from beanhub_import.post_processor import txn_to_text
-from beanhub_import.processor import process_imports
-
-from .cli import cli
-from .environment import Environment
-from .environment import pass_env
-
-IMPORT_DOC_FILE = pathlib.Path(".beanhub") / "imports.yaml"
-
-
-@cli.command(
-    name="import",
-    help="Import data into Beancount files based on the beanhub-import config file",
-)
-@click.option(
-    "-c",
-    "--config",
-    type=click.Path(exists=True, dir_okay=False),
-    default=".beanhub/imports.yaml",
-    help="The path to import config file",
-)
-@click.option(
-    "-w",
-    "--workdir",
-    type=click.Path(exists=True, dir_okay=True, file_okay=False),
-    default=str(pathlib.Path.cwd()),
-    help="The beanhub project path to work on",
-)
-@click.option(
-    "-b",
-    "--beanfile",
-    type=click.Path(exists=True, dir_okay=False, file_okay=True),
-    default="main.bean",
-    help="The path to main entry beancount file",
-)
-@pass_env
-def main(env: Environment, config: str, workdir: str, beanfile: str):
-    config_path = pathlib.Path(config)
-    with config_path.open("rt") as fo:
-        doc_payload = yaml.safe_load(fo)
-    import_doc = ImportDoc.model_validate(doc_payload)
-    workdir_path = pathlib.Path(workdir)
-    env.logger.info("Loaded import doc from %s", config)
-
-    generated_txns = []
-    for generated_txn in process_imports(import_doc=import_doc, input_dir=workdir_path):
-        env.logger.debug("Generated transaction %s", generated_txn)
-        generated_txns.append(generated_txn)
-    env.logger.info("Generated %s transactions", len(generated_txns))
-
-    beanfile_path = pathlib.Path(beanfile)
-
-    parser = make_parser()
-    imported_txns = list(
-        extract_imported_transactions(
-            parser=parser,
-            bean_file=beanfile_path,
-        )
-    )
-    env.logger.info("Found %s existing imported transactions", len(imported_txns))
-
-    formatter = Formatter()
-    change_sets = compute_changes(
-        generated_txns=generated_txns,
-        imported_txns=imported_txns,
-        work_dir=workdir_path,
-    )
-    for target_file, change_set in change_sets.items():
-        if not target_file.exists():
-            if change_set.remove or change_set.update:
-                raise ValueError("Expect new transactions to add only")
-            env.logger.info(
-                "Create new bean file %s with %s transactions",
-                target_file,
-                len(change_set.add),
-            )
-
-            bean_content = "\n\n".join(map(txn_to_text, change_set.add))
-            new_tree = parser.parse(bean_content)
-        else:
-            env.logger.info(
-                "Applying change sets (add=%s, update=%s, remove=%s) to %s",
-                len(change_set.add),
-                len(change_set.update),
-                len(change_set.remove),
-                target_file,
-            )
-            tree = parser.parse(target_file.read_text())
-            new_tree = apply_change_set(tree=tree, change_set=change_set)
-
-        with target_file.open("wt") as fo:
-            formatter.format(new_tree, fo)
-    env.logger.info("done")

{beanhub_cli-1.1.0 → beanhub_cli-1.1.2}/beanhub_cli/cli.py

@@ -23,6 +23,7 @@ from .environment import pass_env
 @click.version_option(prog_name="beanhub-cli", package_name="beanhub-cli")
 @pass_env
 def cli(env: Environment, log_level: str):
+    env.log_level = LogLevel(log_level)
     FORMAT = "%(message)s"
     logging.basicConfig(
         level=LOG_LEVEL_MAP[env.log_level],
@@ -31,4 +32,3 @@ def cli(env: Environment, log_level: str):
         handlers=[RichHandler()],
         force=True,
     )
-    env.log_level = LogLevel(log_level)