bearcli 1.4.0__tar.gz → 1.6.0__tar.gz

{bearcli-1.4.0 → bearcli-1.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bearcli
-Version: 1.4.0
+Version: 1.6.0
 Summary: The missing CLI for Bear notes — read, search, export, and manage your notes from the terminal
 Keywords: bear,notes,cli,markdown,macos
 Author: Michel Tricot
@@ -12,8 +12,7 @@ Classifier: Environment :: Console
 Classifier: Operating System :: MacOS
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Utilities
-Requires-Dist: detect-secrets>=1.5.0
-Requires-Dist: rapidfuzz>=3.14.5
+Requires-Dist: bearkit==1.6.0
 Requires-Dist: textual>=8.2.8
 Requires-Dist: typer>=0.27.0
 Requires-Python: >=3.13
@@ -88,11 +87,13 @@ bearcli stats                                # counts, words, top tags, notes pe
 ### Terminal UI
 
 `bearcli ui` is a full Bear client in the terminal: the note list with live
-filtering on the left, preview and inline markdown editor on the right.
-`/` search - `Enter` edit - `n`/`c` new note - `t`/`T` tag/untag (with
-autocompletion) - `o` open in Bear - `a` archive - `d` trash - `r` reload.
-Notes with detected secrets are marked 🚨; encrypted notes show 🔒 and keep
-their content in Bear.
+filtering on the left, markdown preview and inline editor on the right.
+`/` search - `enter`/`e` edit (`ctrl+s` saves, with an unsaved-changes
+guard) - `n`/`c` new note - `t`/`T` tag/untag - `o` open in Bear - `a`
+archive - `d` trash - `1`/`2`/`3` notes/archive/trash views - `j`/`k`
+navigation - `?` shows the full key map. Notes with detected secrets get a
+red title, a 🚨 badge, and the secret values highlighted in the preview and
+editor; encrypted notes show 🔒 and keep their content in Bear.
 
 ### Search
 
@@ -103,8 +104,8 @@ bearcli search "quarterly planing" --fuzzy   # typo-tolerant, ranked by score
 
 ### Write
 
-Writes go through Bear's x-callback-url API - the database itself is never
-written. These launch the Bear app if needed.
+Writes go through the Bear app itself (launching it if needed), and every
+change is verified before the command reports success.
 
 ```sh
 bearcli create "Meeting notes" --text "agenda..." --tag work
@@ -181,6 +182,28 @@ teaching AI agents (Claude Code, etc.) how to use `bearcli` ships in
 cp -r skills/bear-notes ~/.claude/skills/   # or a project's .claude/skills/
 ```
 
+## Use as a library
+
+The fundamentals ship as their own package on PyPI, `bearkit` - reading
+notes, verified writes, search, and secret detection - with no CLI or TUI
+dependencies (`pip install bearkit`):
+
+```python
+from bearkit import Bear, BearWriteError
+
+with Bear() as bear:
+    for note in bear.list_notes(tag="work", limit=10):
+        print(note.title, note.tags)
+
+    try:
+        bear.add_tag(bear.get_note("C44D09DC"), "from-python")
+    except BearWriteError:
+        print("Bear did not apply the change")
+```
+
+Full reference: [docs/BEARKIT.md](docs/BEARKIT.md). The package ships typed
+(`py.typed`).
+
 ## Development
 
 ```sh
@@ -190,7 +213,7 @@ uv run ty check src/
 uv run python scripts/check_docs.py          # docs must cover every command
 ```
 
-Design notes and Bear database internals: [docs/IMPLEMENTATION.md](docs/IMPLEMENTATION.md).
+Design notes and internals: [docs/IMPLEMENTATION.md](docs/IMPLEMENTATION.md).
 Contributor/agent guidelines: [AGENTS.md](AGENTS.md).
 
 ## License

{bearcli-1.4.0 → bearcli-1.6.0}/README.md

@@ -64,11 +64,13 @@ bearcli stats                                # counts, words, top tags, notes pe
 ### Terminal UI
 
 `bearcli ui` is a full Bear client in the terminal: the note list with live
-filtering on the left, preview and inline markdown editor on the right.
-`/` search - `Enter` edit - `n`/`c` new note - `t`/`T` tag/untag (with
-autocompletion) - `o` open in Bear - `a` archive - `d` trash - `r` reload.
-Notes with detected secrets are marked 🚨; encrypted notes show 🔒 and keep
-their content in Bear.
+filtering on the left, markdown preview and inline editor on the right.
+`/` search - `enter`/`e` edit (`ctrl+s` saves, with an unsaved-changes
+guard) - `n`/`c` new note - `t`/`T` tag/untag - `o` open in Bear - `a`
+archive - `d` trash - `1`/`2`/`3` notes/archive/trash views - `j`/`k`
+navigation - `?` shows the full key map. Notes with detected secrets get a
+red title, a 🚨 badge, and the secret values highlighted in the preview and
+editor; encrypted notes show 🔒 and keep their content in Bear.
 
 ### Search
 
@@ -79,8 +81,8 @@ bearcli search "quarterly planing" --fuzzy   # typo-tolerant, ranked by score
 
 ### Write
 
-Writes go through Bear's x-callback-url API - the database itself is never
-written. These launch the Bear app if needed.
+Writes go through the Bear app itself (launching it if needed), and every
+change is verified before the command reports success.
 
 ```sh
 bearcli create "Meeting notes" --text "agenda..." --tag work
@@ -157,6 +159,28 @@ teaching AI agents (Claude Code, etc.) how to use `bearcli` ships in
 cp -r skills/bear-notes ~/.claude/skills/   # or a project's .claude/skills/
 ```
 
+## Use as a library
+
+The fundamentals ship as their own package on PyPI, `bearkit` - reading
+notes, verified writes, search, and secret detection - with no CLI or TUI
+dependencies (`pip install bearkit`):
+
+```python
+from bearkit import Bear, BearWriteError
+
+with Bear() as bear:
+    for note in bear.list_notes(tag="work", limit=10):
+        print(note.title, note.tags)
+
+    try:
+        bear.add_tag(bear.get_note("C44D09DC"), "from-python")
+    except BearWriteError:
+        print("Bear did not apply the change")
+```
+
+Full reference: [docs/BEARKIT.md](docs/BEARKIT.md). The package ships typed
+(`py.typed`).
+
 ## Development
 
 ```sh
@@ -166,7 +190,7 @@ uv run ty check src/
 uv run python scripts/check_docs.py          # docs must cover every command
 ```
 
-Design notes and Bear database internals: [docs/IMPLEMENTATION.md](docs/IMPLEMENTATION.md).
+Design notes and internals: [docs/IMPLEMENTATION.md](docs/IMPLEMENTATION.md).
 Contributor/agent guidelines: [AGENTS.md](AGENTS.md).
 
 ## License

{bearcli-1.4.0 → bearcli-1.6.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "bearcli"
-version = "1.4.0"
+version = "1.6.0"
 description = "The missing CLI for Bear notes — read, search, export, and manage your notes from the terminal"
 readme = "README.md"
 keywords = ["bear", "notes", "cli", "markdown", "macos"]
@@ -18,8 +18,7 @@ license = "MIT"
 license-files = ["LICENSE"]
 requires-python = ">=3.13"
 dependencies = [
-    "detect-secrets>=1.5.0",
-    "rapidfuzz>=3.14.5",
+    "bearkit==1.6.0",
     "textual>=8.2.8",
     "typer>=0.27.0",
 ]
@@ -32,6 +31,12 @@ Documentation = "https://github.com/michel-tricot/bearcli/blob/main/docs/IMPLEME
 [project.scripts]
 bearcli = "bearcli.cli:app"
 
+[tool.uv.workspace]
+members = ["packages/bearkit"]
+
+[tool.uv.sources]
+bearkit = { workspace = true }
+
 [build-system]
 requires = ["uv_build>=0.8.22,<0.9.0"]
 build-backend = "uv_build"
@@ -48,3 +53,6 @@ line-length = 120
 
 [tool.ruff.lint]
 select = ["E", "F", "W", "I", "UP", "B"]
+
+[tool.ruff.lint.isort]
+known-first-party = ["bearcli", "bearkit"]

{bearcli-1.4.0 → bearcli-1.6.0}/src/bearcli/cli/common.py

@@ -3,7 +3,6 @@
 from __future__ import annotations
 
 import sys
-from collections.abc import Callable
 from datetime import datetime
 from enum import StrEnum
 from pathlib import Path
@@ -12,8 +11,8 @@ from typing import Annotated
 import typer
 from rich.console import Console
 
-from bearcli import actions
-from bearcli.db import AmbiguousNoteId, BearDB, Note, note_metadata
+from bearkit import Bear
+from bearkit.db import AmbiguousNoteId, Note, NoteFilter
 
 app = typer.Typer(help="Read notes from the Bear note app.", no_args_is_help=True, add_completion=False)
 
@@ -34,15 +33,11 @@ class OutputFormat(StrEnum):
     text = "text"
 
 
-class OnlyFilter(StrEnum):
-    pinned = "pinned"
-    encrypted = "encrypted"
-    trashed = "trashed"
-    archived = "archived"
+OnlyFilter = NoteFilter  # typer choices come straight from the library enum
 
 
 def _note_to_dict(note: Note, with_text: bool = False) -> dict:
-    data = note_metadata(note)
+    data = note.to_dict()
     if with_text:
         data["text"] = note.text
         data["attachments"] = [
@@ -63,9 +58,9 @@ DbPathOption = Annotated[
 ]
 
 
-def _open_db(path: Path) -> BearDB:
+def _open_bear(path: Path) -> Bear:
     try:
-        return BearDB(path)
+        return Bear(path)
     except FileNotFoundError as exc:
         console.print(f"[red]Error:[/red] {exc}")
         raise typer.Exit(1) from None
@@ -90,9 +85,9 @@ def _text_or_stdin(text: str | None) -> str | None:
     return text
 
 
-def _require_note(db: BearDB, note_id: str) -> Note:
+def _require_note(bear: Bear, note_id: str) -> Note:
     try:
-        note = db.get_note(note_id)
+        note = bear.get_note(note_id)
     except AmbiguousNoteId as exc:
         console.print(f"[red]Error:[/red] note id prefix {exc.prefix!r} matches several notes:")
         for full_id, title in exc.matches:
@@ -102,11 +97,3 @@ def _require_note(db: BearDB, note_id: str) -> Note:
         console.print(f"[red]Error:[/red] no note with id {note_id!r}")
         raise typer.Exit(1)
     return note
-
-
-def _verify(ok: Callable[[], bool], success: str, failure: str) -> None:
-    if actions.wait_for(ok):
-        console.print(success)
-    else:
-        console.print(f"[red]Error:[/red] {failure}")
-        raise typer.Exit(1)

{bearcli-1.4.0 → bearcli-1.6.0}/src/bearcli/cli/export.py

@@ -12,14 +12,14 @@ from rich.table import Table
 
 from bearcli.cli.common import (
     DbPathOption,
-    _open_db,
+    _open_bear,
     app,
     console,
 )
-from bearcli.db import DEFAULT_DB_PATH
 from bearcli.export import export_notes
 from bearcli.gitsync import GitError, export_and_push
-from bearcli.secrets import SecretFinding, redaction_map, scan_notes
+from bearkit.db import DEFAULT_DB_PATH
+from bearkit.secrets import ScanReport, SecretFinding
 
 
 def _report_secrets(findings: list[SecretFinding]) -> None:
@@ -76,30 +76,29 @@ def export(
     if allow_secrets and redact_secrets:
         console.print("[red]Error:[/red] --allow-secrets and --redact-secrets are mutually exclusive")
         raise typer.Exit(2)
-    db = _open_db(db_path)
+    bear = _open_bear(db_path)
     try:
-        redactions: dict[str, dict[str, str]] | None = None
+        redactions: ScanReport | None = None
         if not allow_secrets:
             with console.status("Scanning notes for secrets…", spinner="dots"):
-                candidates = db.list_notes(limit=None, include_archived=True, with_text=True)
-                findings = scan_notes(candidates)
-            if findings and not redact_secrets:
-                _report_secrets(findings)
+                report = bear.scan_secrets()
+            if report and not redact_secrets:
+                _report_secrets(report.findings)
                 raise typer.Exit(1)
-            if findings:
-                redactions = redaction_map(findings)
+            if report:
+                redactions = report
         with console.status("Exporting…", spinner="dots") as status:
             update = lambda msg: status.update(rich_escape(msg))  # noqa: E731
             if push:
                 try:
-                    result, outcome = export_and_push(db, dest, sync=sync, progress=update, redactions=redactions)
+                    result, outcome = export_and_push(bear.db, dest, sync=sync, progress=update, redactions=redactions)
                 except GitError as exc:
                     console.print(f"[red]Error:[/red] {exc}")
                     raise typer.Exit(1) from None
             else:
-                result = export_notes(db, dest, sync=sync, progress=update, redactions=redactions)
+                result = export_notes(bear.db, dest, sync=sync, progress=update, redactions=redactions)
     finally:
-        db.close()
+        bear.close()
 
     parts = [f"{result.written} written"]
     if push:
@@ -113,6 +112,5 @@ def export(
     if result.index_updated:
         parts.append("index updated")
     if redactions:
-        secrets_count = sum(len(v) for v in redactions.values())
-        parts.append(f"{secrets_count} secret(s) redacted in {len(redactions)} note(s)")
+        parts.append(f"{len(redactions)} secret(s) redacted in {redactions.notes_affected()} note(s)")
     console.print(f"Exported to {dest}: " + ", ".join(parts))

{bearcli-1.4.0 → bearcli-1.6.0}/src/bearcli/cli/misc.py

@@ -12,11 +12,11 @@ from rich.table import Table
 from bearcli.cli.common import (
     DbPathOption,
     OutputFormat,
-    _open_db,
+    _open_bear,
     app,
     console,
 )
-from bearcli.db import DEFAULT_DB_PATH
+from bearkit.db import DEFAULT_DB_PATH
 
 
 @app.command()
@@ -28,13 +28,13 @@ def stats(
     db_path: DbPathOption = DEFAULT_DB_PATH,
 ) -> None:
     """Show statistics about the note library."""
-    db = _open_db(db_path)
+    bear = _open_bear(db_path)
     try:
-        notes = db.list_notes(limit=None, include_trashed=True, include_archived=True, with_text=True)
-        tag_counts = db.list_tags()
-        attachment_count, attachment_bytes = db.attachment_stats()
+        notes = bear.list_notes(limit=None, include_trashed=True, include_archived=True)
+        tag_counts = bear.list_tags()
+        attachment_count, attachment_bytes = bear.attachment_stats()
     finally:
-        db.close()
+        bear.close()
 
     active = [n for n in notes if not n.trashed and not n.archived]
     by_year: dict[str, int] = {}
@@ -101,9 +101,5 @@ def ui(
     """Bear in the terminal: search, edit, create, tag, and organize notes."""
     from bearcli.tui import run_ui
 
-    db = _open_db(db_path)
-    try:
-        notes = db.list_notes(limit=None, tag=tag_filter, with_text=True)
-    finally:
-        db.close()
-    run_ui(notes, fuzzy=fuzzy, db_path=db_path, tag_filter=tag_filter)
+    _open_bear(db_path).close()  # fail fast with a clear message if the db is missing
+    run_ui(fuzzy=fuzzy, db_path=db_path, tag_filter=tag_filter)