rechnomat 0.1.0__tar.gz

rechnomat-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Sebastian Haberey
+
+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.

rechnomat-0.1.0/MANIFEST.in

@@ -0,0 +1 @@
+recursive-include src/rechnomat/resources *

rechnomat-0.1.0/PKG-INFO

@@ -0,0 +1,110 @@
+Metadata-Version: 2.4
+Name: rechnomat
+Version: 0.1.0
+Summary: Create invoices compliant with German E-Rechnung laws
+Author-email: Sebastian Haberey <sebastian@haberey.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/sebastianhaberey/rechnomat
+Project-URL: Repository, https://github.com/sebastianhaberey/rechnomat
+Project-URL: Bug Tracker, https://github.com/sebastianhaberey/rechnomat/issues
+Project-URL: Changelog, https://github.com/sebastianhaberey/rechnomat/blob/main/CHANGELOG.md
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Environment :: Console
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click==8.4.2
+Requires-Dist: cloup==3.1.0
+Requires-Dist: jinja2==3.1.6
+Requires-Dist: playwright==1.62.0
+Requires-Dist: pydantic==2.13.4
+Requires-Dist: pypdf==6.16.1
+Requires-Dist: pyyaml==6.0.3
+Requires-Dist: rich==15.0.0
+Provides-Extra: dev
+Requires-Dist: pytest==9.1.1; extra == "dev"
+Requires-Dist: ruff==0.16.3; extra == "dev"
+Dynamic: license-file
+
+# rechnomat
+
+Create invoices compliant with German E-Rechnung laws.
+
+## Installation
+
+```
+git clone https://github.com/sebastianhaberey/rechnomat.git
+cd rechnomat
+pip install .
+playwright install chromium
+```
+
+Invoice PDFs are rendered by driving a headless Chromium instance (via
+[Playwright](https://playwright.dev/python/)) over HTML/CSS templates. `playwright install
+chromium` downloads the browser binary Playwright needs; it's a one-time, per-machine step, not a
+pip package, and is required before `rechnomat render-invoice` will work.
+
+### Getting started
+
+The tool reads `backgrounds/`, `customers/`, `invoices/`, `seller/` and `templates/` from the
+current directory, not from the installed package. Before running `rechnomat render-invoice`, run
+`rechnomat init` inside whichever directory you run `rechnomat` from; it copies these five
+folders, pre-filled with example data, from `src/rechnomat/resources/` into the current directory.
+Folders that already exist are left untouched, so re-running `init` later only fills in whatever
+is still missing; you are notified whether each folder was copied or skipped.
+
+### System dependencies for headless Chromium (Linux only)
+
+On Linux, Chromium also needs a handful of shared libraries that aren't installed by default.
+macOS needs no extra step here - skip this section.
+
+**Debian/Ubuntu:**
+
+```
+sudo playwright install-deps chromium
+```
+
+**Fedora:** `playwright install-deps` only knows how to drive `apt-get`, so on Fedora it fails
+outright (`spawn apt-get ENOENT`). Install the equivalent packages with `dnf` instead:
+
+```
+sudo dnf install -y atk at-spi2-atk at-spi2-core cups-libs libXcomposite libXdamage libXfixes
+```
+
+If `rechnomat render-invoice` fails with "Host system is missing dependencies to run browsers",
+run `ldd` against the downloaded Chromium binary to see exactly which `.so` is missing:
+
+```
+ldd ~/.cache/ms-playwright/chromium-*/chrome-linux/chrome | grep "not found"
+```
+
+## Usage
+
+```
+rechnomat --help
+```
+
+## Development
+
+For an editable install with test and lint tooling:
+
+```
+pip install -e '.[dev]'
+playwright install chromium
+```
+
+Tests use the example data and templates bundled in `src/rechnomat/resources/` directly.
+
+```
+pytest
+ruff check .
+ruff format --check .
+```
+
+## License
+
+MIT - see [LICENSE](LICENSE).

rechnomat-0.1.0/README.md

@@ -0,0 +1,78 @@
+# rechnomat
+
+Create invoices compliant with German E-Rechnung laws.
+
+## Installation
+
+```
+git clone https://github.com/sebastianhaberey/rechnomat.git
+cd rechnomat
+pip install .
+playwright install chromium
+```
+
+Invoice PDFs are rendered by driving a headless Chromium instance (via
+[Playwright](https://playwright.dev/python/)) over HTML/CSS templates. `playwright install
+chromium` downloads the browser binary Playwright needs; it's a one-time, per-machine step, not a
+pip package, and is required before `rechnomat render-invoice` will work.
+
+### Getting started
+
+The tool reads `backgrounds/`, `customers/`, `invoices/`, `seller/` and `templates/` from the
+current directory, not from the installed package. Before running `rechnomat render-invoice`, run
+`rechnomat init` inside whichever directory you run `rechnomat` from; it copies these five
+folders, pre-filled with example data, from `src/rechnomat/resources/` into the current directory.
+Folders that already exist are left untouched, so re-running `init` later only fills in whatever
+is still missing; you are notified whether each folder was copied or skipped.
+
+### System dependencies for headless Chromium (Linux only)
+
+On Linux, Chromium also needs a handful of shared libraries that aren't installed by default.
+macOS needs no extra step here - skip this section.
+
+**Debian/Ubuntu:**
+
+```
+sudo playwright install-deps chromium
+```
+
+**Fedora:** `playwright install-deps` only knows how to drive `apt-get`, so on Fedora it fails
+outright (`spawn apt-get ENOENT`). Install the equivalent packages with `dnf` instead:
+
+```
+sudo dnf install -y atk at-spi2-atk at-spi2-core cups-libs libXcomposite libXdamage libXfixes
+```
+
+If `rechnomat render-invoice` fails with "Host system is missing dependencies to run browsers",
+run `ldd` against the downloaded Chromium binary to see exactly which `.so` is missing:
+
+```
+ldd ~/.cache/ms-playwright/chromium-*/chrome-linux/chrome | grep "not found"
+```
+
+## Usage
+
+```
+rechnomat --help
+```
+
+## Development
+
+For an editable install with test and lint tooling:
+
+```
+pip install -e '.[dev]'
+playwright install chromium
+```
+
+Tests use the example data and templates bundled in `src/rechnomat/resources/` directly.
+
+```
+pytest
+ruff check .
+ruff format --check .
+```
+
+## License
+
+MIT - see [LICENSE](LICENSE).

rechnomat-0.1.0/pyproject.toml

@@ -0,0 +1,78 @@
+[build-system]
+requires = ["setuptools>=64", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "rechnomat"
+version = "0.1.0"
+description = "Create invoices compliant with German E-Rechnung laws"
+readme = "README.md"
+requires-python = ">=3.14"
+
+license = "MIT"
+
+authors = [
+    { name = "Sebastian Haberey", email = "sebastian@haberey.com" }
+]
+
+dependencies = [
+    "click==8.4.2",
+    "cloup==3.1.0",
+    "jinja2==3.1.6",
+    "playwright==1.62.0",
+    "pydantic==2.13.4",
+    "pypdf==6.16.1",
+    "pyyaml==6.0.3",
+    "rich==15.0.0",
+]
+
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.14",
+    "Operating System :: MacOS :: MacOS X",
+    "Operating System :: POSIX :: Linux",
+    "Environment :: Console",
+]
+
+[project.urls]
+Homepage = "https://github.com/sebastianhaberey/rechnomat"
+Repository = "https://github.com/sebastianhaberey/rechnomat"
+"Bug Tracker" = "https://github.com/sebastianhaberey/rechnomat/issues"
+Changelog = "https://github.com/sebastianhaberey/rechnomat/blob/main/CHANGELOG.md"
+
+[project.scripts]
+rechnomat = "rechnomat.__main__:main"
+
+[project.optional-dependencies]
+dev = [
+    "pytest==9.1.1",
+    "ruff==0.16.3",
+]
+
+[tool.setuptools]
+package-dir = { "" = "src" }
+include-package-data = true
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+rechnomat = ["resources/**/*"]
+
+[tool.ruff]
+line-length = 120
+target-version = "py314"
+src = ["src", "tools"]
+
+[tool.ruff.lint]
+select = [
+    "E", # Pycodestyle (basic errors)
+    "F", # Pyflakes (unused imports, etc.)
+    "W", # Warnings
+    "I", # Import sorting (isort behavior)
+    "UP", # pyupgrade: e.g., prefer dict[str, int] over Dict[str, int]
+]
+
+[tool.ruff.format]
+quote-style = "double"

rechnomat-0.1.0/setup.cfg

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

rechnomat-0.1.0/src/rechnomat/__main__.py

@@ -0,0 +1,34 @@
+import sys
+from pathlib import Path
+
+import rechnomat.cli
+from rechnomat import ui
+from rechnomat.cli import cli
+
+
+def main():
+    args = sys.argv[1:]
+    if render_newlines(args):
+        ui.newline()
+    try:
+        rechnomat_executable = Path(sys.argv[0])
+        cli.main(args, obj={"rechnomat_executable": rechnomat_executable})
+    except Exception as e:
+        if rechnomat.cli.DEBUG_MODE:
+            ui.stacktrace("Error while running rechnomat")
+        else:
+            ui.exception(e)
+    finally:
+        if render_newlines(args):
+            ui.newline()
+
+
+def render_newlines(args: list[str]) -> bool:
+    """Quick and dirty hack to evaluate if the two framing newlines should be rendered"""
+    if "--headless" in args:
+        return False  # don't output anything in headless mode to avoid system mails
+    return True
+
+
+if __name__ == "__main__":
+    main()

rechnomat-0.1.0/src/rechnomat/cli.py

@@ -0,0 +1,127 @@
+import logging
+from pathlib import Path
+
+import cloup
+from click import help_option, pass_obj, version_option
+from cloup import HelpFormatter, HelpTheme, Section, argument, group, option, pass_context
+
+from rechnomat.command.add_invoice import AddInvoiceCommand
+from rechnomat.command.info import InfoCommand
+from rechnomat.command.init import InitCommand
+from rechnomat.command.render_invoice import RenderInvoiceCommand
+from rechnomat.model import Context, Paths
+from rechnomat.theme import StyleId, theme
+
+logger = logging.getLogger(__name__)
+
+STYLES = theme().styles_cloup
+
+CONTEXT_SETTINGS = cloup.Context.settings(
+    formatter_settings=HelpFormatter.settings(
+        theme=HelpTheme(
+            invoked_command=STYLES[StyleId.SECONDARY],
+            heading=STYLES[StyleId.HEADER],
+            col1=STYLES[StyleId.PRIMARY],
+        ),
+        width=120,
+        max_width=120,  # default is too low (80), but too high will yield really long help text lines
+    ),
+)
+
+SECTION_MAIN = Section("Main commands")
+SECTION_UTILITY = Section("Utility commands")
+
+# TODO SH find a better way to pass debug flag to exception handling
+DEBUG_MODE: bool = False
+
+
+@group(help="Rechnomat - create invoices compliant with German E-Rechnung laws", context_settings=CONTEXT_SETTINGS)
+@help_option(help="Show this page")
+@version_option(prog_name="Rechnomat", help="Show version information", message="%(prog)s version %(version)s")
+@option(
+    "--debug",
+    envvar="EASYBORG_DEBUG",
+    is_flag=True,
+    help="Enable debug mode",
+)
+@pass_context
+def cli(
+    ctx: cloup.Context,
+    debug: bool,
+) -> None:
+    # first, set DEBUG_MODE flag to enable stacktraces
+    global DEBUG_MODE
+    DEBUG_MODE = debug
+
+    ctx.ensure_object(dict)
+
+    paths = Paths(root=Path.cwd(), output_dir=Path.cwd())
+    rechnomat_executable = ctx.obj.pop("rechnomat_executable", None)
+
+    ctx.obj["context"] = Context(
+        debug=debug,
+        rechnomat_executable=rechnomat_executable,
+        paths=paths,
+    )
+
+
+@cli.command(section=SECTION_MAIN)
+@option(
+    "-o",
+    "--overwrite",
+    is_flag=True,
+    help="Replace existing directories instead of skipping them",
+)
+@help_option(help="Show this message")
+@pass_obj
+def init(obj, overwrite):
+    """
+    Copy the bundled example customers, invoices, seller and templates into the current directory
+    """
+    command = InitCommand(overwrite=overwrite)
+    command.run(obj["context"])
+
+
+@cli.command(section=SECTION_MAIN, name="add-invoice")
+@argument(
+    "customer-name",
+    required=False,
+    help="Customer to create the invoice for, references a Customer file by its filename stem (defaults to "
+    "whichever customer is on the most recent invoice)",
+)
+@help_option(help="Show this message")
+@pass_obj
+def add_invoice(obj, customer_name):
+    """
+    Add a new invoice, copying the customer's most recent invoice, or the most recent invoice
+    overall, or the bundled example invoice - whichever is found first
+    """
+    command = AddInvoiceCommand(customer_name=customer_name)
+    command.run(obj["context"])
+
+
+@cli.command(section=SECTION_MAIN, name="render-invoice")
+@argument(
+    "invoice-number",
+    required=False,
+    help="Invoice number to render (defaults to the highest-numbered invoice in invoices/)",
+)
+@help_option(help="Show this message")
+@pass_obj
+def render_invoice(obj, invoice_number):
+    """
+    Render an invoice as a PDF
+    """
+    command = RenderInvoiceCommand(invoice_number=invoice_number)
+    command.run(obj["context"])
+
+
+@cli.command(section=SECTION_UTILITY)
+@help_option(help="Show this message")
+@pass_obj
+def info(obj):
+    """
+    Show current configuration, paths etc.
+    """
+    command = InfoCommand()
+    command.run(obj["context"])

rechnomat-0.1.0/src/rechnomat/command/add_invoice.py

@@ -0,0 +1,80 @@
+import re
+from pathlib import Path
+
+import yaml
+
+from rechnomat import ui
+from rechnomat.command.init import RESOURCES_DIR
+from rechnomat.invoice_numbering import (
+    find_highest_invoice_number,
+    find_highest_matching_invoice_number,
+    increment_invoice_number,
+)
+from rechnomat.model import Context
+
+EXAMPLE_INVOICES_DIR = RESOURCES_DIR / "invoices"
+
+_CUSTOMER_FIELD_PATTERN = re.compile(r'^(customer:\s*)"[^"]*"', re.MULTILINE)
+
+
+class AddInvoiceCommand:
+    def __init__(self, *, customer_name: str | None = None) -> None:
+        super().__init__()
+        self.customer_name = customer_name
+
+    def run(self, context: Context) -> None:
+        paths = context.paths
+
+        if self.customer_name is not None:
+            customer_file = paths.customer_file(self.customer_name)
+            if not customer_file.exists():
+                raise RuntimeError(f"Customer file not found: {customer_file}")
+
+        invoices_dir = paths.invoices_dir
+        customer_invoice_number = (
+            find_highest_matching_invoice_number(invoices_dir, self._belongs_to_customer)
+            if self.customer_name is not None
+            else None
+        )
+        highest_invoice_number = find_highest_invoice_number(invoices_dir)
+
+        if customer_invoice_number is not None:
+            source_file = paths.invoice_file(customer_invoice_number)
+            rewrite_customer = False
+        elif highest_invoice_number is not None:
+            source_file = paths.invoice_file(highest_invoice_number)
+            rewrite_customer = self.customer_name is not None
+        else:
+            example_number = find_highest_invoice_number(EXAMPLE_INVOICES_DIR)
+            if example_number is None:
+                raise RuntimeError(f"No example invoice found in: {EXAMPLE_INVOICES_DIR}")
+            source_file = EXAMPLE_INVOICES_DIR / f"{example_number}.yml"
+            rewrite_customer = self.customer_name is not None
+
+        if not source_file.exists():
+            raise RuntimeError(f"Invoice file not found: {source_file}")
+
+        new_invoice_number = (
+            increment_invoice_number(highest_invoice_number) if highest_invoice_number is not None else source_file.stem
+        )
+
+        target_file = paths.invoice_file(new_invoice_number)
+
+        content = source_file.read_text(encoding="utf-8")
+        if rewrite_customer:
+            content = self._with_customer(content)
+
+        target_file.parent.mkdir(parents=True, exist_ok=True)
+        target_file.write_text(content, encoding="utf-8")
+
+        ui.success("Added invoice", str(target_file))
+
+    def _belongs_to_customer(self, invoice_file: Path) -> bool:
+        data = yaml.safe_load(invoice_file.read_text(encoding="utf-8"))
+        return isinstance(data, dict) and data.get("customer") == self.customer_name
+
+    def _with_customer(self, content: str) -> str:
+        new_content, count = _CUSTOMER_FIELD_PATTERN.subn(rf'\1"{self.customer_name}"', content, count=1)
+        if count == 0:
+            raise RuntimeError("Source invoice file has no 'customer' field to replace")
+        return new_content

rechnomat-0.1.0/src/rechnomat/command/info.py

@@ -0,0 +1,25 @@
+from rechnomat import ui
+from rechnomat.model import Context
+from rechnomat.theme import StyleId, theme
+
+STYLES = theme().styles
+
+
+class InfoCommand:
+    def __init__(self) -> None:
+        super().__init__()
+
+    def run(self, context: Context) -> None:
+        rows = [
+            ("Executable", context.rechnomat_executable),
+            ("Customers directory", context.paths.customers_dir),
+            ("Invoices directory", context.paths.invoices_dir),
+            ("Seller directory", context.paths.seller_dir),
+            ("Templates directory", context.paths.templates_dir),
+            ("Output directory", context.paths.output_dir),
+        ]
+        ui.header("Context", first=True)
+        ui.table(
+            rows,
+            column_colors=(STYLES[StyleId.PRIMARY], None),
+        )

rechnomat-0.1.0/src/rechnomat/command/init.py

@@ -0,0 +1,36 @@
+import importlib.resources
+import shutil
+
+from rechnomat import ui
+from rechnomat.model import Context
+
+RESOURCES_DIR = importlib.resources.files("rechnomat") / "resources"
+
+
+class InitCommand:
+    def __init__(self, overwrite: bool = False) -> None:
+        self.overwrite = overwrite
+
+    def run(self, context: Context) -> None:
+        paths = context.paths
+        resources = (
+            ("backgrounds", paths.backgrounds_dir),
+            ("customers", paths.customers_dir),
+            ("invoices", paths.invoices_dir),
+            ("seller", paths.seller_dir),
+            ("templates", paths.templates_dir),
+        )
+
+        for name, target_dir in resources:
+            replaced = False
+
+            if target_dir.exists():
+                if not self.overwrite:
+                    ui.warn("Skipped", f"{target_dir} (already exists)")
+                    continue
+
+                shutil.rmtree(target_dir)
+                replaced = True
+
+            shutil.copytree(RESOURCES_DIR / name, target_dir)
+            ui.success("Replaced" if replaced else "Copied", str(target_dir))

rechnomat-0.1.0/src/rechnomat/command/render_invoice.py

@@ -0,0 +1,56 @@
+from rechnomat import ui
+from rechnomat.invoice_numbering import find_highest_invoice_number
+from rechnomat.invoice_pdf import render_invoice_pdf
+from rechnomat.model import Context, Customer, Invoice, Seller
+from rechnomat.yaml_io import load_model
+
+
+class RenderInvoiceCommand:
+    def __init__(self, *, invoice_number: str | None = None) -> None:
+        super().__init__()
+        self.invoice_number = invoice_number
+
+    def run(self, context: Context) -> None:
+        invoices_dir = context.paths.invoices_dir
+
+        invoice_number = self.invoice_number or find_highest_invoice_number(invoices_dir)
+        if invoice_number is None:
+            raise RuntimeError(f"No invoices found in: {invoices_dir}")
+
+        invoice_file = context.paths.invoice_file(invoice_number)
+        if not invoice_file.exists():
+            raise RuntimeError(f"Invoice file not found: {invoice_file}")
+        invoice = load_model(invoice_file, Invoice)
+
+        customer_file = context.paths.customer_file(invoice.customer)
+        if not customer_file.exists():
+            raise RuntimeError(f"Customer file not found: {customer_file}")
+        customer = load_model(customer_file, Customer)
+
+        seller_file = context.paths.seller_file
+        if not seller_file.exists():
+            raise RuntimeError(f"Seller file not found: {seller_file}")
+        seller = load_model(seller_file, Seller)
+
+        template_dir = context.paths.template_dir(invoice.layout.template)
+        if not template_dir.exists():
+            raise RuntimeError(f"Template directory not found: {template_dir}")
+
+        background_path = None
+        if invoice.layout.background is not None:
+            background_path = context.paths.background_file(invoice.layout.background)
+            if not background_path.exists():
+                raise RuntimeError(f"Background file not found: {background_path}")
+
+        target_file = context.paths.output_dir / f"{invoice_number}.pdf"
+        render_invoice_pdf(
+            invoice=invoice,
+            invoice_number=invoice_number,
+            customer=customer,
+            seller=seller,
+            output_path=target_file,
+            template_dir=template_dir,
+            background_path=background_path,
+        )
+
+        ui.success("Rendered invoice PDF", str(target_file))