rustfava 0.1.0__tar.gz → 0.1.3__tar.gz

rustfava-0.1.3/PKG-INFO

@@ -0,0 +1,133 @@
+Metadata-Version: 2.4
+Name: rustfava
+Version: 0.1.3
+Summary: Web interface for the accounting tool rustledger.
+Author-email: Dominik Aumayr <dominik@aumayr.name>
+Maintainer-email: Jakob Schnitzer <mail@jakobschnitzer.de>
+License-Expression: MIT
+Project-URL: Repository, https://github.com/rustledger/rustfava
+Project-URL: Documentation, https://rustledger.github.io/rustfava
+Project-URL: Issues, https://github.com/rustledger/rustfava/issues
+Project-URL: Changelog, https://github.com/rustledger/rustfava/releases
+Keywords: rustfava,fava,beancount,accounting,rustledger
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Flask
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: Intended Audience :: Information Technology
+Classifier: Natural Language :: English
+Classifier: Programming Language :: JavaScript
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Classifier: Topic :: Office/Business :: Financial :: Accounting
+Classifier: Topic :: Office/Business :: Financial :: Investment
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: AUTHORS
+Requires-Dist: Babel<3,>=2.11
+Requires-Dist: Flask-Babel<5,>=3
+Requires-Dist: Flask<4,>=2.2
+Requires-Dist: Jinja2<4,>=3
+Requires-Dist: Werkzeug<4,>=2.2
+Requires-Dist: beangulp>=0.1
+Requires-Dist: cheroot<12,>=8
+Requires-Dist: click<9,>=7
+Requires-Dist: markdown2<3,>=2.3.0
+Requires-Dist: ply>=3.11
+Requires-Dist: pydantic>=2.0
+Requires-Dist: watchfiles>=0.20.0
+Provides-Extra: excel
+Requires-Dist: pyexcel>=0.5; extra == "excel"
+Requires-Dist: pyexcel-ods3>=0.5; extra == "excel"
+Requires-Dist: pyexcel-xlsx>=0.5; extra == "excel"
+Provides-Extra: beancount-compat
+Requires-Dist: beancount<4,>=2; extra == "beancount-compat"
+Dynamic: license-file
+
+<div align="center">
+
+# rustfava
+
+**A beautiful desktop app for [rustledger](https://github.com/rustledger/rustledger)**
+
+Manage your finances with plain text accounting.
+
+[![CI](https://github.com/rustledger/rustfava/actions/workflows/test.yml/badge.svg)](https://github.com/rustledger/rustfava/actions/workflows/test.yml)
+[![GitHub Release](https://img.shields.io/github/v/release/rustledger/rustfava)](https://github.com/rustledger/rustfava/releases)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
+[![PyPI](https://img.shields.io/pypi/v/rustfava)](https://pypi.org/project/rustfava/)
+
+![rustfava dashboard](docs/screenshot.png)
+
+</div>
+
+---
+
+## Why rustfava?
+
+| | |
+|---|---|
+| **Native app** | Double-click to launch, no terminal required |
+| **Fava interface** | The familiar Fava web UI you know and love |
+| **rustledger backend** | Blazing fast parsing via WebAssembly |
+| **Cross-platform** | Linux, macOS (Intel & Apple Silicon), Windows |
+| **Offline first** | Your financial data stays on your machine |
+| **Multiple files** | Open multiple ledgers in tabs |
+
+## Install
+
+### Desktop App
+
+Download the latest release for your platform from the [Releases page](https://github.com/rustledger/rustfava/releases/latest).
+
+| Platform | Format |
+|----------|--------|
+| **macOS** | `.dmg` (Intel & Apple Silicon) |
+| **Windows** | `.exe` installer or `.msi` |
+| **Linux** | `.AppImage`, `.deb`, `.rpm`, or `.tar.gz` |
+
+### Other Installation Methods
+
+| Method | Command |
+|--------|---------|
+| **Docker** | `docker run -p 5000:5000 -v /path/to/ledger:/data ghcr.io/rustledger/rustfava /data/main.beancount` |
+| **PyPI** | `uv tool install rustfava` (requires Python 3.13+ and [wasmtime](https://wasmtime.dev/)) |
+| **Nix** | `nix run github:rustledger/rustfava#desktop` |
+
+<sub>Missing your platform? [Open an issue](https://github.com/rustledger/rustfava/issues/new) to request it.</sub>
+
+## Quick Start
+
+### Desktop App
+
+1. Download the app for your platform
+2. Double-click to launch
+3. Open your `.beancount` file
+
+### Command Line
+
+```bash
+rustfava ledger.beancount
+# Then visit http://localhost:5000
+```
+
+## What is this?
+
+rustfava is a fork of [Fava](https://github.com/beancount/fava) that replaces the Python beancount parser with [rustledger](https://github.com/rustledger/rustledger), compiled to WebAssembly for faster parsing and processing.
+
+The desktop app bundles everything into a native application using [Tauri](https://tauri.app/), so you get a fast, lightweight app with no dependencies.
+
+## Links
+
+- **Website**: https://rustledger.github.io/rustfava/
+- **Documentation**: https://rustledger.github.io/rustfava/docs/
+- **rustledger**: https://github.com/rustledger/rustledger
+
+## License
+
+MIT License - see [LICENSE](LICENSE) for details.

rustfava-0.1.3/README.md

@@ -0,0 +1,82 @@
+<div align="center">
+
+# rustfava
+
+**A beautiful desktop app for [rustledger](https://github.com/rustledger/rustledger)**
+
+Manage your finances with plain text accounting.
+
+[![CI](https://github.com/rustledger/rustfava/actions/workflows/test.yml/badge.svg)](https://github.com/rustledger/rustfava/actions/workflows/test.yml)
+[![GitHub Release](https://img.shields.io/github/v/release/rustledger/rustfava)](https://github.com/rustledger/rustfava/releases)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
+[![PyPI](https://img.shields.io/pypi/v/rustfava)](https://pypi.org/project/rustfava/)
+
+![rustfava dashboard](docs/screenshot.png)
+
+</div>
+
+---
+
+## Why rustfava?
+
+| | |
+|---|---|
+| **Native app** | Double-click to launch, no terminal required |
+| **Fava interface** | The familiar Fava web UI you know and love |
+| **rustledger backend** | Blazing fast parsing via WebAssembly |
+| **Cross-platform** | Linux, macOS (Intel & Apple Silicon), Windows |
+| **Offline first** | Your financial data stays on your machine |
+| **Multiple files** | Open multiple ledgers in tabs |
+
+## Install
+
+### Desktop App
+
+Download the latest release for your platform from the [Releases page](https://github.com/rustledger/rustfava/releases/latest).
+
+| Platform | Format |
+|----------|--------|
+| **macOS** | `.dmg` (Intel & Apple Silicon) |
+| **Windows** | `.exe` installer or `.msi` |
+| **Linux** | `.AppImage`, `.deb`, `.rpm`, or `.tar.gz` |
+
+### Other Installation Methods
+
+| Method | Command |
+|--------|---------|
+| **Docker** | `docker run -p 5000:5000 -v /path/to/ledger:/data ghcr.io/rustledger/rustfava /data/main.beancount` |
+| **PyPI** | `uv tool install rustfava` (requires Python 3.13+ and [wasmtime](https://wasmtime.dev/)) |
+| **Nix** | `nix run github:rustledger/rustfava#desktop` |
+
+<sub>Missing your platform? [Open an issue](https://github.com/rustledger/rustfava/issues/new) to request it.</sub>
+
+## Quick Start
+
+### Desktop App
+
+1. Download the app for your platform
+2. Double-click to launch
+3. Open your `.beancount` file
+
+### Command Line
+
+```bash
+rustfava ledger.beancount
+# Then visit http://localhost:5000
+```
+
+## What is this?
+
+rustfava is a fork of [Fava](https://github.com/beancount/fava) that replaces the Python beancount parser with [rustledger](https://github.com/rustledger/rustledger), compiled to WebAssembly for faster parsing and processing.
+
+The desktop app bundles everything into a native application using [Tauri](https://tauri.app/), so you get a fast, lightweight app with no dependencies.
+
+## Links
+
+- **Website**: https://rustledger.github.io/rustfava/
+- **Documentation**: https://rustledger.github.io/rustfava/docs/
+- **rustledger**: https://github.com/rustledger/rustledger
+
+## License
+
+MIT License - see [LICENSE](LICENSE) for details.

{rustfava-0.1.0 → rustfava-0.1.3}/_build_backend.py

@@ -9,8 +9,6 @@ from os import walk
 from pathlib import Path
 from typing import TYPE_CHECKING
 
-from babel.messages.mofile import write_mo
-from babel.messages.pofile import read_po
 from setuptools import build_meta
 from setuptools.build_meta import get_requires_for_build_editable
 from setuptools.build_meta import get_requires_for_build_sdist
@@ -69,6 +67,10 @@ def _compile_frontend() -> None:
 
 def _compile_translations() -> None:
     """Compile the translations from .po to .mo (if changed or missing)."""
+    # Lazy import to avoid requiring Babel for metadata preparation
+    from babel.messages.mofile import write_mo
+    from babel.messages.pofile import read_po
+
     for source in Path().glob("src/rustfava/translations/**/messages.po"):
         target = source.parent / "messages.mo"
         if (

rustfava-0.1.3/contrib/docker/README.md

@@ -0,0 +1,129 @@
+# Deploying with Docker
+
+## Quick Start (Pre-built Image)
+
+The easiest way to run rustfava with Docker is using the pre-built image from GitHub Container Registry:
+
+```bash
+docker run -p 5000:5000 -v /path/to/ledger:/data ghcr.io/rustledger/rustfava /data/main.beancount
+```
+
+Then visit http://localhost:5000.
+
+## Building Your Own Image
+
+The Dockerfile in this directory allows you to build a custom rustfava image.
+
+### Building
+
+```bash
+docker build -t rustfava .
+```
+
+To incorporate a new version of rustfava, use the `--no-cache` flag:
+
+```bash
+docker build --no-cache -t rustfava .
+```
+
+### Running
+
+```bash
+docker run --detach --name="rustfava" --publish 5000:5000 \
+  --volume $(pwd)/ledger.beancount:/data/ledger.beancount \
+  rustfava /data/ledger.beancount
+```
+
+Arguments explained:
+
+- `--detach`: Run in the background as a daemon
+- `--name`: Name for the container instance
+- `--publish`: Expose container port 5000 to localhost:5000
+- `--volume`: Mount your beancount file into the container
+
+Visit http://localhost:5000 to access rustfava.
+
+## Advanced Deployment
+
+For production deployments with authentication and HTTPS, see the following sections.
+
+### Reverse Proxy with Authentication
+
+For a secure, authenticated deployment, use a reverse proxy like nginx or Caddy with OAuth2 authentication.
+
+Example with [oauth2-proxy](https://github.com/oauth2-proxy/oauth2-proxy):
+
+```bash
+# Run rustfava
+docker run --detach --name="rustfava" \
+  --volume $(pwd)/ledger:/data \
+  ghcr.io/rustledger/rustfava /data/main.beancount
+
+# Run oauth2-proxy in front
+docker run --detach --name="rustfava-auth" \
+  --link rustfava \
+  --publish 4180:4180 \
+  quay.io/oauth2-proxy/oauth2-proxy \
+  --upstream="http://rustfava:5000" \
+  --provider=google \
+  --client-id="YOUR_CLIENT_ID" \
+  --client-secret="YOUR_CLIENT_SECRET" \
+  --cookie-secret="YOUR_COOKIE_SECRET" \
+  --email-domain="yourdomain.com"
+```
+
+### HTTPS with Let's Encrypt
+
+For automatic HTTPS certificates, use [Caddy](https://caddyserver.com/) as a reverse proxy:
+
+```yaml
+# docker-compose.yml
+services:
+  rustfava:
+    image: ghcr.io/rustledger/rustfava
+    command: /data/main.beancount
+    volumes:
+      - ./ledger:/data
+
+  caddy:
+    image: caddy:2
+    ports:
+      - "80:80"
+      - "443:443"
+    volumes:
+      - ./Caddyfile:/etc/caddy/Caddyfile
+      - caddy_data:/data
+
+volumes:
+  caddy_data:
+```
+
+```
+# Caddyfile
+your-domain.com {
+    reverse_proxy rustfava:5000
+}
+```
+
+Caddy automatically obtains and renews Let's Encrypt certificates.
+
+### Docker Compose Example
+
+A complete example with persistent data:
+
+```yaml
+# docker-compose.yml
+services:
+  rustfava:
+    image: ghcr.io/rustledger/rustfava
+    command: /data/main.beancount
+    ports:
+      - "5000:5000"
+    volumes:
+      - ./ledger:/data
+    restart: unless-stopped
+```
+
+```bash
+docker compose up -d
+```

rustfava-0.1.3/contrib/pyinstaller_spec.spec

@@ -0,0 +1,102 @@
+# vim: set ft=python:
+"""Pyinstaller spec file for building a binary from rustfava's cli.py
+
+This spec works without pip installing rustfava - it uses the source directly.
+"""
+
+from __future__ import annotations
+
+import os
+import sys
+from pathlib import Path
+
+from PyInstaller.utils.hooks import collect_data_files
+from PyInstaller.utils.hooks import collect_submodules
+
+# Get the project root (parent of contrib/)
+spec_dir = Path(SPECPATH)
+project_root = spec_dir.parent
+src_dir = project_root / "src"
+rustfava_dir = src_dir / "rustfava"
+
+# Add src/ to path so PyInstaller can find rustfava
+sys.path.insert(0, str(src_dir))
+
+# Collect data files from source directory
+datas = []
+
+# Static files (CSS, JS, etc.)
+static_dir = rustfava_dir / "static"
+if static_dir.exists():
+    for f in static_dir.rglob("*"):
+        if f.is_file():
+            rel_path = f.relative_to(rustfava_dir)
+            datas.append((str(f), f"rustfava/{rel_path.parent}"))
+
+# Templates
+templates_dir = rustfava_dir / "templates"
+if templates_dir.exists():
+    for f in templates_dir.rglob("*"):
+        if f.is_file():
+            rel_path = f.relative_to(rustfava_dir)
+            datas.append((str(f), f"rustfava/{rel_path.parent}"))
+
+# Translations (.mo files)
+translations_dir = rustfava_dir / "translations"
+if translations_dir.exists():
+    for f in translations_dir.rglob("*.mo"):
+        rel_path = f.relative_to(rustfava_dir)
+        datas.append((str(f), f"rustfava/{rel_path.parent}"))
+
+# WASM file for rustledger
+wasm_file = rustfava_dir / "rustledger" / "rustledger-wasi.wasm"
+if wasm_file.exists():
+    datas.append((str(wasm_file), "rustfava/rustledger"))
+
+# Help files
+help_dir = rustfava_dir / "help"
+if help_dir.exists():
+    for f in help_dir.rglob("*"):
+        if f.is_file():
+            rel_path = f.relative_to(rustfava_dir)
+            datas.append((str(f), f"rustfava/{rel_path.parent}"))
+
+# Hidden imports
+hiddenimports = [
+    "rustfava",
+    "rustfava.application",
+    "rustfava.cli",
+    "rustfava.core",
+    "rustfava.rustledger",
+    "rustfava.serialisation",
+]
+
+# Optionally add beancount for legacy plugin support
+try:
+    hiddenimports += collect_submodules("beancount")
+    datas += collect_data_files("beancount")
+except Exception:
+    pass
+
+a = Analysis(
+    [str(rustfava_dir / "cli.py")],
+    pathex=[str(src_dir)],
+    datas=datas,
+    hiddenimports=hiddenimports,
+)
+
+pyz = PYZ(
+    a.pure,
+    a.zipped_data,
+)
+
+exe = EXE(
+    pyz,
+    a.scripts,
+    a.binaries,
+    a.zipfiles,
+    a.datas,
+    [],
+    name="rustfava",
+    upx=True,
+)

{rustfava-0.1.0 → rustfava-0.1.3}/desktop/src-tauri/capabilities/default.json

@@ -13,6 +13,11 @@
           "name": "binaries/rustfava-server",
           "sidecar": true,
           "args": true
+        },
+        {
+          "name": "rustfava",
+          "cmd": "rustfava",
+          "args": true
         }
       ]
     },

{rustfava-0.1.0 → rustfava-0.1.3}/desktop/src-tauri/src/main.rs

@@ -39,8 +39,8 @@ fn get_example_file_path(app: AppHandle) -> Result<String, String> {
     let resource_dir = app.path().resource_dir()
         .map_err(|e| format!("Failed to get resource dir: {}", e))?;
 
-    // Try bundled resource first
-    let bundled_path = resource_dir.join("examples").join("example.beancount");
+    // Try bundled resource first (copied to resources root by Tauri)
+    let bundled_path = resource_dir.join("example.beancount");
     if bundled_path.exists() {
         return Ok(bundled_path.to_string_lossy().to_string());
     }
@@ -115,16 +115,8 @@ fn open_file(
     // Find a free port
     let port = find_free_port();
 
-    // Spawn the sidecar binary
-    let sidecar = app
-        .shell()
-        .sidecar("rustfava-server")
-        .map_err(|e| format!("Failed to create sidecar command: {}", e))?
-        .args([&path, "-p", &port.to_string()]);
-
-    let (mut _rx, child) = sidecar
-        .spawn()
-        .map_err(|e| format!("Failed to spawn sidecar: {}", e))?;
+    // Try sidecar first (bundled releases), then fall back to PATH (NixOS/system install)
+    let child = spawn_rustfava_server(&app, &path, port)?;
 
     // Generate tab ID and store
     let tab_id = generate_id(&state, "tab");
@@ -147,6 +139,29 @@ fn open_file(
     }))
 }
 
+/// Spawn rustfava server - tries sidecar first, then falls back to PATH
+fn spawn_rustfava_server(app: &AppHandle, path: &str, port: u16) -> Result<CommandChild, String> {
+    // Try bundled sidecar first (for AppImage/DMG/MSI releases)
+    if let Ok(sidecar) = app.shell().sidecar("rustfava-server") {
+        if let Ok((_, child)) = sidecar.args([path, "-p", &port.to_string()]).spawn() {
+            return Ok(child);
+        }
+    }
+
+    // Fall back to rustfava-server from PATH (for NixOS flake installs)
+    // The flake creates symlinks without the target triple suffix
+    let command = app
+        .shell()
+        .command("rustfava-server")
+        .args([path, "-p", &port.to_string()]);
+
+    let (_, child) = command
+        .spawn()
+        .map_err(|e| format!("Failed to spawn rustfava-server: {}. Make sure the desktop app is properly installed.", e))?;
+
+    Ok(child)
+}
+
 /// Close a tab and kill its server
 #[tauri::command]
 fn close_tab(tab_id: String, state: State<AppState>) -> Result<(), String> {

{rustfava-0.1.0 → rustfava-0.1.3}/desktop/src-tauri/tauri.conf.json

@@ -29,6 +29,9 @@
   "bundle": {
     "active": true,
     "targets": "all",
+    "resources": [
+      "../../contrib/examples/example.beancount"
+    ],
     "icon": [
       "icons/32x32.png",
       "icons/128x128.png",

rustfava-0.1.3/desktop-sources.json

@@ -0,0 +1,7 @@
+{
+  "version": "0.1.2",
+  "x86_64-linux": {
+    "url": "https://github.com/rustledger/rustfava/releases/download/v0.1.2/rustfava-desktop-x86_64-unknown-linux-gnu.tar.gz",
+    "hash": "sha256-+ZWYhww1/XGlEh9ym+XG4nOiLP0qnZo5220zxtTTjp8="
+  }
+}

rustfava-0.1.3/docs/deployment.md

@@ -0,0 +1,92 @@
+# Deployment
+
+There are several ways to deploy rustfava depending on your needs.
+
+## Desktop App
+
+For personal use, the [desktop app](https://github.com/rustledger/rustfava/releases) is the simplest option. It runs entirely locally with no server setup required.
+
+## Docker
+
+For server deployments, Docker is recommended:
+
+```bash
+docker run -p 5000:5000 -v /path/to/ledger:/data ghcr.io/rustledger/rustfava /data/main.beancount
+```
+
+For advanced Docker configurations (authentication, HTTPS, docker-compose), see the [Docker deployment guide](../contrib/docker/README.md).
+
+## Systemd Service
+
+To run rustfava as a system service on Linux:
+
+```ini
+# /etc/systemd/system/rustfava.service
+[Unit]
+Description=rustfava Web UI for Beancount
+After=network.target
+
+[Service]
+Type=simple
+ExecStart=/usr/bin/rustfava --host 127.0.0.1 --port 5000 /path/to/main.beancount
+User=your-user
+Restart=on-failure
+
+[Install]
+WantedBy=multi-user.target
+```
+
+Then:
+
+```bash
+sudo systemctl enable rustfava
+sudo systemctl start rustfava
+```
+
+## Reverse Proxy
+
+### Apache
+
+```apache
+ProxyPass "/rustfava" "http://localhost:5000/rustfava"
+ProxyPassReverse "/rustfava" "http://localhost:5000/rustfava"
+```
+
+Run rustfava with the `--prefix` option:
+
+```bash
+rustfava --prefix /rustfava /path/to/main.beancount
+```
+
+### Nginx
+
+```nginx
+location /rustfava/ {
+    proxy_pass http://127.0.0.1:5000/rustfava/;
+    proxy_set_header Host $host;
+    proxy_set_header X-Real-IP $remote_addr;
+    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+    proxy_set_header X-Forwarded-Proto $scheme;
+}
+```
+
+### Caddy
+
+```
+your-domain.com {
+    reverse_proxy localhost:5000
+}
+```
+
+Caddy automatically handles HTTPS with Let's Encrypt.
+
+## Security Considerations
+
+When exposing rustfava to the internet:
+
+1. **Use HTTPS** - Never expose plain HTTP to the public internet
+2. **Add authentication** - Use a reverse proxy with OAuth2 or basic auth
+3. **Restrict access** - Use firewall rules to limit access to trusted IPs
+4. **Keep updated** - Regularly update rustfava for security patches
+
+See [SECURITY.md](../SECURITY.md) for more security best practices.

rustfava-0.1.3/docs/index.md

@@ -0,0 +1,35 @@
+# Welcome to rustfava!
+
+rustfava is a web interface for double-entry bookkeeping, powered by
+[rustledger](https://github.com/rustledger/rustledger), a Rust-based parser for
+the Beancount file format compiled to WebAssembly for fast processing.
+
+rustfava is a fork of [Fava](https://beancount.github.io/fava/) that replaces
+the Python Beancount parser with rustledger for improved performance. Your
+existing Beancount files are fully compatible.
+
+![rustfava dashboard](screenshot.png)
+
+If you are new to rustfava or Beancount-format files, begin with the
+[Getting Started](usage.md) guide.
+
+## Quick Start
+
+### Desktop App (Recommended)
+
+Download the desktop app from [GitHub Releases](https://github.com/rustledger/rustfava/releases) - no installation required, just double-click to run.
+
+### Command Line
+
+```bash
+uv tool install rustfava
+rustfava ledger.beancount
+```
+
+Then visit [http://localhost:5000](http://localhost:5000).
+
+### Docker
+
+```bash
+docker run -p 5000:5000 -v /path/to/ledger:/data ghcr.io/rustledger/rustfava /data/main.beancount
+```