beanhub-cli 1.4.0__tar.gz → 1.4.2__tar.gz

{beanhub_cli-1.4.0 → beanhub_cli-1.4.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: beanhub-cli
-Version: 1.4.0
+Version: 1.4.2
 Summary: Command line tools for BeanHub
 License: MIT
 Author: Fang-Pen Lin
@@ -25,17 +25,20 @@ Requires-Dist: pyyaml (>=6.0.1,<7.0.0)
 Requires-Dist: rich (>=13.6.0,<14.0.0)
 Requires-Dist: starlette-wtf (>=0.4.3,<0.5.0)
 Requires-Dist: uvicorn (>=0.23.2,<1.0.0)
+Project-URL: Documentation, https://beanhub-cli-docs.beanhub.io
 Description-Content-Type: text/markdown
 
 # beanhub-cli [![CircleCI](https://dl.circleci.com/status-badge/img/gh/LaunchPlatform/beanhub-cli/tree/master.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/LaunchPlatform/beanhub-cli/tree/master)
 Command line tools for BeanHub or Beancount users.
 
+Please read the [documentation here](https://beanhub-cli-docs.beanhub.io).
+
 ## 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)
+- **Basic Beancount file manipulations** - Effortless Beancount account name renaming and other basic manipulations
 - **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
 
 ## Screenshots
@@ -52,69 +55,3 @@ Command line tools for BeanHub or Beancount users.
 
 A modern accounting book service based on the most popular open source version control system [Git](https://git-scm.com/) and text-based double entry accounting book software [Beancount](https://beancount.github.io/docs/index.html).
 
-## Install
-
-```bash
-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.
-You can run it by
-
-```bash
-bh form server
-```
-
-It should open the BeanHub Forms web page locally at http://localhost:8080 by default.
-It reads the `.beanhub/forms.yaml` file from the current directory and will modify beancount files in the directory, so make sure you cd to your beancount directory before running the command.
-To learn more about BeanHub Forms, please read our blog post [Automating Beancount data input with custom forms makes your life 10 times easier!](https://beanhub.io/blog/2023/07/31/automating-beancount-data-input-with-beanhub-custom-forms/).
-
-### List BeanHub Forms
-
-To list BeanHub Forms, simply run
-
-```bash
-bh form list
-```
-### Validate BeanHub Forms doc
-
-To validate BeanHub Forms doc, simply run
-
-```bash
-bh form validate
-```
-
-### Format beancount files
-
-You can run [beancount-black](https://github.com/LaunchPlatform/beancount-black) formatter against given files by the following command
-
-```bash
-bh format main.bean
-```
-
-Without the file arguments, the format command will try to format `main.bean` in the current folder, and it will recursively follow all the `include` statements to format all the bean files.
-Like this:
-
-```bash
-bh format
-```
-
-### More features to come
-
-We are working on basic beancount file manipulation features, such as renaming account names.
-We will also add new features only for BeanHub users as well.
-But in general, if possible, we would like to make the features added to beancount-cli work locally without a BeanHub account as much as possible so that the beancount community can benefit from it.
-

beanhub_cli-1.4.2/README.md

@@ -0,0 +1,26 @@
+# beanhub-cli [![CircleCI](https://dl.circleci.com/status-badge/img/gh/LaunchPlatform/beanhub-cli/tree/master.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/LaunchPlatform/beanhub-cli/tree/master)
+Command line tools for BeanHub or Beancount users.
+
+Please read the [documentation here](https://beanhub-cli-docs.beanhub.io).
+
+## 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
+- **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
+
+## Screenshots
+
+<p align="center">
+  <img src="https://github.com/LaunchPlatform/beanhub-cli/raw/master/assets/forms-screenshot.png?raw=true" alt="BeanHub Forms Screenshot" />
+</p>
+
+# Sponsor
+
+<p align="center">
+  <a href="https://beanhub.io"><img src="https://github.com/LaunchPlatform/beanhub-cli/raw/master/assets/beanhub.svg?raw=true" alt="BeanHub logo" /></a>
+</p>
+
+A modern accounting book service based on the most popular open source version control system [Git](https://git-scm.com/) and text-based double entry accounting book software [Beancount](https://beancount.github.io/docs/index.html).

{beanhub_cli-1.4.0 → beanhub_cli-1.4.2}/beanhub_cli/cli.py

@@ -2,6 +2,7 @@ import logging
 import os
 
 import click
+from rich.logging import Console
 from rich.logging import RichHandler
 
 from .aliase import AliasedGroup
@@ -25,10 +26,11 @@ from .environment import pass_env
 def cli(env: Environment, log_level: str):
     env.log_level = LogLevel(log_level)
     FORMAT = "%(message)s"
+    console = Console(stderr=True)
     logging.basicConfig(
         level=LOG_LEVEL_MAP[env.log_level],
         format=FORMAT,
         datefmt="[%X]",
-        handlers=[RichHandler()],
+        handlers=[RichHandler(console=console)],
         force=True,
     )

{beanhub_cli-1.4.0 → beanhub_cli-1.4.2}/beanhub_cli/format.py

@@ -1,3 +1,5 @@
+import copy
+import functools
 import pathlib
 import shutil
 import sys
@@ -9,12 +11,15 @@ from beancount_black.formatter import Formatter
 from beancount_parser.parser import make_parser
 from beancount_parser.parser import traverse
 from lark import Lark
+from lark import Token
 from lark import Tree
 
 from .cli import cli
 from .environment import Environment
 from .environment import pass_env
 
+TreeOrToken = Token | Tree
+
 
 def create_backup(src: pathlib.Path, suffix: str) -> pathlib.Path:
     """Create a backup file
@@ -45,11 +50,92 @@ def file_tree_iterator(
             yield filename, tree
 
 
+def walk_tree(
+    tree_or_token: TreeOrToken,
+    processor: typing.Callable[[TreeOrToken], TreeOrToken | None],
+):
+    result = processor(tree_or_token)
+    if result is not None:
+        # processor returned, let's use it instead
+        return result
+    if isinstance(tree_or_token, Tree):
+        return Tree(
+            data=tree_or_token.data,
+            children=list(
+                map(
+                    functools.partial(walk_tree, processor=processor),
+                    tree_or_token.children,
+                )
+            ),
+            meta=tree_or_token.meta,
+        )
+    return copy.deepcopy(tree_or_token)
+
+
+def rename_account_transform(
+    replacements: dict[str, str], tree_or_token: TreeOrToken
+) -> TreeOrToken | None:
+    if not isinstance(tree_or_token, Token):
+        return
+    if tree_or_token.type != "ACCOUNT":
+        return
+    if tree_or_token.value not in replacements:
+        return
+    new_token = copy.deepcopy(tree_or_token)
+    new_token.value = replacements[tree_or_token.value]
+    return new_token
+
+
+def rename_commodity_transform(
+    replacements: dict[str, str], tree_or_token: TreeOrToken
+) -> TreeOrToken | None:
+    if not isinstance(tree_or_token, Token):
+        return
+    if tree_or_token.type != "CURRENCY":
+        return
+    if tree_or_token.value not in replacements:
+        return
+    new_token = copy.deepcopy(tree_or_token)
+    new_token.value = replacements[tree_or_token.value]
+    return new_token
+
+
+def combine_transforms(
+    funcs: list[typing.Callable], tree_or_token: TreeOrToken
+) -> TreeOrToken | None:
+    transformed = False
+    for func in funcs:
+        result = func(tree_or_token)
+        if result is None:
+            continue
+        transformed = True
+        tree_or_token = result
+    if not transformed:
+        return
+    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",
@@ -60,11 +146,27 @@ def file_tree_iterator(
 @pass_env
 def main(
     env: Environment,
-    filename: typing.List[click.Path],
+    filename: list[click.Path],
     backup_suffix: str,
+    rename_account: list[tuple[str, str]],
+    rename_currency: list[tuple[str, str]],
     stdin_mode: bool,
     backup: bool,
 ):
+    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)
+        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)
+        tree_transformers.append(
+            functools.partial(rename_commodity_transform, dict(rename_currency))
+        )
+
     # TODO: support follow include statements
     parser = make_parser()
     if stdin_mode:
@@ -88,6 +190,16 @@ def main(
             )
         for filepath, tree in iterator:
             env.logger.info("Processing file %s", filepath)
+            if tree_transformers:
+                env.logger.info(
+                    "Running %s transforms against file %s ...",
+                    len(tree_transformers),
+                    filepath,
+                )
+                tree = walk_tree(
+                    tree,
+                    functools.partial(combine_transforms, tree_transformers),
+                )
             with tempfile.NamedTemporaryFile(mode="wt+", suffix=".bean") as output_file:
                 formatter = Formatter()
                 formatter.format(tree, output_file)