formulens 0.0.1__tar.gz

formulens-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2026 Rajesh Das (rajeshdas.dev)
+
+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.

formulens-0.0.1/PKG-INFO

@@ -0,0 +1,87 @@
+Metadata-Version: 2.4
+Name: formulens
+Version: 0.0.1
+Summary: Local equation-to-LaTeX recognition with a Linux-first CLI.
+Keywords: latex,equations,ocr,cli,linux,configuration
+Author: Rajesh Das
+Author-email: Rajesh Das <hyperoot.tech@proton.me>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Requires-Dist: pydantic>=2.13.5
+Requires-Dist: typer>=0.27.2
+Requires-Dist: utilityhub-config>=0.2.7
+Requires-Python: >=3.14
+Project-URL: Homepage, https://formulens.hyperoot.dev/
+Project-URL: Documentation, https://formulens.hyperoot.dev/
+Project-URL: Repository, https://github.com/HYP3R00T/formulens
+Project-URL: Issues, https://github.com/HYP3R00T/formulens/issues
+Description-Content-Type: text/markdown
+
+# Formulens
+
+Formulens is a Linux-first CLI for a local equation-to-LaTeX workflow.
+
+Version **0.0.1** provides configuration management through Typer and UtilityHub
+Config. Equation recognition, screen capture, daemon mode, and clipboard
+integration are not implemented in this release.
+
+## Installation
+
+Requires Python **3.14 or newer**. After this release is published, install it with
+[uv](https://docs.astral.sh/uv/):
+
+```bash
+uv tool install formulens
+```
+
+## Configuration
+
+```bash
+formulens --help
+formulens config init
+formulens config path
+formulens config show
+formulens config set notifications false
+```
+
+Settings are stored at `~/.config/formulens/formulens.toml`:
+
+```toml
+copy_to_clipboard = true
+notifications = true
+```
+
+`init` preserves existing configuration. `path` prints its location. `show`
+displays effective settings as JSON without creating files. `set` validates and
+saves an edit. These preferences are stored for future desktop integration;
+they do not yet trigger clipboard output or notifications.
+
+Environment variables such as `FORMULENS_NOTIFICATIONS=false` override saved
+values. Formulens loads global TOML/YAML configuration and any `.env` inside its
+configuration directory, without searching the current working directory.
+`set` updates only the TOML file and does not save environment overrides.
+
+## Development
+
+From a checkout of the repository:
+
+```bash
+uv sync --all-packages
+uv run formulens --help
+uv run python -m unittest discover -s tests
+```
+
+See the [project repository](https://github.com/HYP3R00T/formulens) for development
+setup and documentation.
+
+## License
+
+MIT. Copyright 2026 Rajesh Das. The license is included in the distribution.

formulens-0.0.1/README.md

@@ -0,0 +1,60 @@
+# Formulens
+
+Formulens is a Linux-first CLI for a local equation-to-LaTeX workflow.
+
+Version **0.0.1** provides configuration management through Typer and UtilityHub
+Config. Equation recognition, screen capture, daemon mode, and clipboard
+integration are not implemented in this release.
+
+## Installation
+
+Requires Python **3.14 or newer**. After this release is published, install it with
+[uv](https://docs.astral.sh/uv/):
+
+```bash
+uv tool install formulens
+```
+
+## Configuration
+
+```bash
+formulens --help
+formulens config init
+formulens config path
+formulens config show
+formulens config set notifications false
+```
+
+Settings are stored at `~/.config/formulens/formulens.toml`:
+
+```toml
+copy_to_clipboard = true
+notifications = true
+```
+
+`init` preserves existing configuration. `path` prints its location. `show`
+displays effective settings as JSON without creating files. `set` validates and
+saves an edit. These preferences are stored for future desktop integration;
+they do not yet trigger clipboard output or notifications.
+
+Environment variables such as `FORMULENS_NOTIFICATIONS=false` override saved
+values. Formulens loads global TOML/YAML configuration and any `.env` inside its
+configuration directory, without searching the current working directory.
+`set` updates only the TOML file and does not save environment overrides.
+
+## Development
+
+From a checkout of the repository:
+
+```bash
+uv sync --all-packages
+uv run formulens --help
+uv run python -m unittest discover -s tests
+```
+
+See the [project repository](https://github.com/HYP3R00T/formulens) for development
+setup and documentation.
+
+## License
+
+MIT. Copyright 2026 Rajesh Das. The license is included in the distribution.

formulens-0.0.1/pyproject.toml

@@ -0,0 +1,48 @@
+[project]
+name = "formulens"
+version = "0.0.1"
+description = "Local equation-to-LaTeX recognition with a Linux-first CLI."
+readme = "README.md"
+requires-python = ">=3.14"
+license = "MIT"
+license-files = ["LICENSE"]
+keywords = [
+    "latex",
+    "equations",
+    "ocr",
+    "cli",
+    "linux",
+    "configuration",
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Intended Audience :: Science/Research",
+    "Operating System :: POSIX :: Linux",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Scientific/Engineering :: Mathematics",
+]
+dependencies = [
+    "pydantic>=2.13.5",
+    "typer>=0.27.2",
+    "utilityhub-config>=0.2.7",
+]
+
+[[project.authors]]
+name = "Rajesh Das"
+email = "hyperoot.tech@proton.me"
+
+[project.scripts]
+formulens = "formulens:main"
+
+[project.urls]
+Homepage = "https://formulens.hyperoot.dev/"
+Documentation = "https://formulens.hyperoot.dev/"
+Repository = "https://github.com/HYP3R00T/formulens"
+Issues = "https://github.com/HYP3R00T/formulens/issues"
+
+[build-system]
+requires = ["uv_build>=0.12.7,<0.13.0"]
+build-backend = "uv_build"

formulens-0.0.1/pyproject.toml.orig

@@ -0,0 +1,38 @@
+[project]
+name = "formulens"
+version = "0.0.1"
+description = "Local equation-to-LaTeX recognition with a Linux-first CLI."
+readme = "README.md"
+requires-python = ">=3.14"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [{ name = "Rajesh Das", email = "hyperoot.tech@proton.me" }]
+keywords = ["latex", "equations", "ocr", "cli", "linux", "configuration"]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Environment :: Console",
+  "Intended Audience :: Science/Research",
+  "Operating System :: POSIX :: Linux",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.14",
+  "Topic :: Scientific/Engineering :: Mathematics",
+]
+dependencies = [
+  "pydantic>=2.13.5",
+  "typer>=0.27.2",
+  "utilityhub-config>=0.2.7",
+]
+
+[project.scripts]
+formulens = "formulens:main"
+
+[project.urls]
+Homepage = "https://formulens.hyperoot.dev/"
+Documentation = "https://formulens.hyperoot.dev/"
+Repository = "https://github.com/HYP3R00T/formulens"
+Issues = "https://github.com/HYP3R00T/formulens/issues"
+
+[build-system]
+requires = ["uv_build>=0.12.7,<0.13.0"]
+build-backend = "uv_build"

formulens-0.0.1/src/formulens/__init__.py

@@ -0,0 +1,7 @@
+"""Formulens command-line entry point."""
+
+
+def main() -> None:
+    from formulens.cli import app
+
+    app()

formulens-0.0.1/src/formulens/cli.py

@@ -0,0 +1,8 @@
+"""Assemble the Formulens CLI from its command groups."""
+
+import typer
+
+from formulens.commands.config import app as config_app
+
+app = typer.Typer(help="Local equation-to-LaTeX tools.", no_args_is_help=True)
+app.add_typer(config_app, name="config")

formulens-0.0.1/src/formulens/commands/__init__.py

@@ -0,0 +1 @@
+"""CLI command groups and presentation helpers."""

formulens-0.0.1/src/formulens/commands/config.py

@@ -0,0 +1,43 @@
+"""Commands for managing Formulens configuration."""
+
+from typing import Annotated
+
+import typer
+
+from formulens.commands.errors import run_config_action
+from formulens.configuration.storage import (
+    get_settings_path,
+    initialize_settings,
+    load_configuration,
+    set_setting,
+)
+
+app = typer.Typer(help="Manage configuration in ~/.config/formulens.", no_args_is_help=True)
+
+
+@app.command("init")
+def config_init() -> None:
+    """Create default configuration, preserving any existing settings."""
+    typer.echo(run_config_action(initialize_settings))
+
+
+@app.command("path")
+def config_path() -> None:
+    """Print the configuration path without creating a file."""
+    typer.echo(get_settings_path())
+
+
+@app.command("show")
+def config_show() -> None:
+    """Print effective settings as JSON, including environment overrides."""
+    settings = run_config_action(load_configuration)
+    typer.echo(settings.model_dump_json(indent=2))
+
+
+@app.command("set")
+def config_set(
+    key: Annotated[str, typer.Argument(help="Setting name, such as notifications.")],
+    value: Annotated[str, typer.Argument(help="New value: true or false.")],
+) -> None:
+    """Validate and save a setting in the global TOML file."""
+    typer.echo(run_config_action(lambda: set_setting(key, value)))

formulens-0.0.1/src/formulens/commands/errors.py

@@ -0,0 +1,16 @@
+"""Translate configuration failures into CLI errors."""
+
+from collections.abc import Callable
+
+import typer
+from pydantic import ValidationError
+from utilityhub_config.errors import ConfigError
+
+
+def run_config_action[T](action: Callable[[], T]) -> T:
+    """Report configuration failures without a Python traceback."""
+    try:
+        return action()
+    except (ConfigError, ValidationError, OSError, ValueError, RuntimeError) as error:
+        typer.echo(f"Configuration error: {error}", err=True)
+        raise typer.Exit(code=1) from error

formulens-0.0.1/src/formulens/configuration/__init__.py

@@ -0,0 +1 @@
+"""Typed settings and persistence, independent of the CLI."""

formulens-0.0.1/src/formulens/configuration/schema.py

@@ -0,0 +1,12 @@
+"""Validated Formulens preferences."""
+
+from pydantic import BaseModel, ConfigDict
+
+
+class Settings(BaseModel):
+    """Preferences for clipboard output and desktop notifications."""
+
+    model_config = ConfigDict(extra="forbid")
+
+    copy_to_clipboard: bool = True
+    notifications: bool = True

formulens-0.0.1/src/formulens/configuration/storage.py

@@ -0,0 +1,50 @@
+"""Load and save user configuration through UtilityHub Config."""
+
+import tomllib
+from pathlib import Path
+
+from utilityhub_config import ensure_config_file, get_config_path, load_settings, write_config
+
+from formulens.configuration.schema import Settings
+
+
+def get_settings_path() -> Path:
+    return get_config_path("formulens")
+
+
+def initialize_settings() -> Path:
+    """Create defaults without overwriting an existing configuration."""
+    path = get_settings_path()
+    if path.exists():
+        read_saved_settings()
+    return ensure_config_file(Settings(), "formulens")
+
+
+def read_saved_settings() -> Settings:
+    """Read only persisted values, so edits never save environment overrides."""
+    path = get_settings_path()
+    if not path.exists():
+        return Settings()
+    with path.open("rb") as stream:
+        return Settings.model_validate(tomllib.load(stream))
+
+
+def load_configuration() -> Settings:
+    """Resolve settings without discovering files in the current directory."""
+    settings, _ = load_settings(
+        Settings,
+        app_name="formulens",
+        cwd=get_settings_path().parent,
+        env_prefix="FORMULENS",
+    )
+    return settings
+
+
+def set_setting(key: str, value: str) -> Path:
+    """Validate a single edit before writing the saved configuration."""
+    if key not in Settings.model_fields:
+        raise ValueError(f"Unknown setting '{key}'. Choose from: {', '.join(Settings.model_fields)}")
+    values = read_saved_settings().model_dump()
+    values[key] = value
+    settings = Settings.model_validate(values)
+    return write_config(settings, "formulens")