bejw 0.2.0__tar.gz

bejw-0.2.0/PKG-INFO

@@ -0,0 +1,39 @@
+Metadata-Version: 2.4
+Name: bejw
+Version: 0.2.0
+Summary: A capped reading list for links that shimmer
+Author: menisadi
+Project-URL: Homepage, https://github.com/menisadi/bejw
+Project-URL: Repository, https://github.com/menisadi/bejw
+Project-URL: Changelog, https://github.com/menisadi/bejw/blob/main/CHANGELOG.md
+Keywords: cli,reading-list,links,productivity
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+Requires-Dist: rich>=14.3.2
+Requires-Dist: typer>=0.21.1
+
+# bejw
+
+A small CLI to keep a capped reading list of links in a local JSON file.
+
+## Install
+
+```bash
+uv sync
+```
+
+## Usage
+
+```bash
+python main.py --help
+python main.py init --capacity 10
+python main.py add "https://example.com" "Example"
+python main.py list
+python main.py remove <id>
+python main.py capacity 5
+python main.py clear
+```
+
+## Storage
+
+By default, data is stored in `~/.bejw/links.json`.

bejw-0.2.0/README.md

@@ -0,0 +1,25 @@
+# bejw
+
+A small CLI to keep a capped reading list of links in a local JSON file.
+
+## Install
+
+```bash
+uv sync
+```
+
+## Usage
+
+```bash
+python main.py --help
+python main.py init --capacity 10
+python main.py add "https://example.com" "Example"
+python main.py list
+python main.py remove <id>
+python main.py capacity 5
+python main.py clear
+```
+
+## Storage
+
+By default, data is stored in `~/.bejw/links.json`.

bejw-0.2.0/bejw/main.py

@@ -0,0 +1,88 @@
+"""
+bejw:  A capped reading list for links that shimmer
+"""
+from pathlib import Path
+
+import typer
+
+from .models import CapacityError, ReadingList
+from .render import render_links
+from .storage import load, save
+
+DEFAULT_CAPACITY = 10
+DEFAULT_FILE_PATH = "~/.bejw/links.json"
+
+app = typer.Typer()
+
+
+@app.callback(invoke_without_command=True)
+def main(context: typer.Context) -> None:
+    """Entry point that shows basic info when no subcommand is provided."""
+    if context.invoked_subcommand is not None:
+        return
+    typer.echo("bejw: A capped reading list for links that shimmer")
+    typer.echo("Run with --help to see commands and options.")
+
+
+@app.command()
+def init(capacity: int = DEFAULT_CAPACITY, file_path: str = DEFAULT_FILE_PATH) -> None:
+    """Initialize the reading list with a specified capacity and file path."""
+    # NOTE: this will override existing reading list
+    # TODO: add a confirmation prompt before overriding
+    reading_list = ReadingList(capacity=capacity)
+    save(reading_list, file_path)
+    expanded_path = str(Path(file_path).expanduser())
+    typer.echo(f"Initialized reading list at {expanded_path} with capacity {capacity}")
+
+
+@app.command()
+def add(url: str, title: str, file_path: str = DEFAULT_FILE_PATH) -> None:
+    """Add a link to the reading list."""
+    reading_list = load(file_path)
+    try:
+        link = reading_list.add_link(url, title)
+    except CapacityError:
+        typer.echo("Reading list is full! Please remove a link before adding a new one.")
+        raise typer.Exit(code=1)
+    save(reading_list, file_path)
+    typer.echo(f"Added {link.id}")
+
+
+@app.command()
+def remove(link_id: str, file_path: str = DEFAULT_FILE_PATH) -> None:
+    """Remove a link from the reading list by id."""
+    reading_list = load(file_path)
+    removed = reading_list.remove_link(link_id)
+    save(reading_list, file_path)
+    if not removed:
+        typer.echo("No link found with that id.")
+        raise typer.Exit(code=1)
+
+
+@app.command()
+def list(file_path: str = DEFAULT_FILE_PATH, show_ids: bool = False) -> None:
+    """Display the reading list."""
+    reading_list = load(file_path)
+    render_links(reading_list, show_ids=show_ids)
+
+
+@app.command()
+def capacity(value: int, file_path: str = DEFAULT_FILE_PATH) -> None:
+    """Change the capacity of the reading list."""
+    reading_list = load(file_path)
+    reading_list.capacity = value
+    save(reading_list, file_path)
+    typer.echo(f"Capacity set to {value}")
+
+
+@app.command()
+def clear(file_path: str = DEFAULT_FILE_PATH) -> None:
+    """Clear the reading list."""
+    reading_list = load(file_path)
+    reading_list.clear_links()
+    save(reading_list, file_path)
+    typer.echo("Reading list cleared")
+
+
+if __name__ == "__main__":
+    app()

bejw-0.2.0/bejw/models.py

@@ -0,0 +1,56 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import Iterable
+from uuid import uuid4
+
+
+class CapacityError(Exception):
+    """Raised when trying to add a link to a full reading list."""
+    def __init__(self, message: str = "Reading list is full") -> None:
+        super().__init__(message)
+    
+
+
+@dataclass(frozen=True)
+class Link:
+    id: str
+    url: str
+    title: str
+
+    @staticmethod
+    def create(url: str, title: str) -> "Link":
+        return Link(id=str(uuid4()), url=url, title=title)
+
+
+class ReadingList:
+    def __init__(self, capacity: int = 10, links: Iterable[Link] | None = None) -> None:
+        self.capacity = capacity
+        self.links: list[Link] = list(links or [])
+
+    def add_link(self, url: str, title: str) -> Link:
+        if len(self.links) >= self.capacity:
+            raise CapacityError("Reading list is full")
+        link = Link.create(url, title)
+        self.links.append(link)
+        return link
+
+    def remove_link(self, link_id: str) -> bool:
+        before = len(self.links)
+        self.links = [link for link in self.links if link.id != link_id]
+        return len(self.links) < before
+
+    def clear_links(self) -> None:
+        self.links = []
+
+    def to_dict(self) -> dict:
+        return {
+            "capacity": self.capacity,
+            "links": [link.__dict__ for link in self.links],
+        }
+
+    @staticmethod
+    def from_dict(data: dict) -> "ReadingList":
+        links = [Link(**item) for item in data.get("links", [])]
+        capacity = data.get("capacity", 10)
+        return ReadingList(capacity=capacity, links=links)

bejw-0.2.0/bejw/render.py

@@ -0,0 +1,24 @@
+from rich.console import Console
+from rich.table import Table
+
+from .models import ReadingList
+
+console = Console()
+
+
+def render_links(reading_list: ReadingList, show_ids: bool = False) -> None:
+    table = Table(title="Bejeweled Reading List")
+    if show_ids:
+        table.add_column("ID", style="cyan", no_wrap=True)
+    table.add_column("Title", style="magenta")
+    table.add_column("URL", style="green")
+
+    for link in reading_list.links:
+        row = []
+        if show_ids:
+            row.append(str(link.id))
+        row.append(link.title)
+        row.append(link.url)
+        table.add_row(*row)
+
+    console.print(table)

bejw-0.2.0/bejw/storage.py

@@ -0,0 +1,22 @@
+from __future__ import annotations
+
+import json
+from pathlib import Path
+
+from .models import ReadingList
+
+
+def load(file_path: str) -> ReadingList:
+    """Load the reading list from a JSON file."""
+    path = Path(file_path).expanduser()
+    if not path.exists():
+        return ReadingList()
+    data = json.loads(path.read_text(encoding="utf-8"))
+    return ReadingList.from_dict(data)
+
+
+def save(reading_list: ReadingList, file_path: str) -> None:
+    path = Path(file_path).expanduser()
+    path.parent.mkdir(parents=True, exist_ok=True)
+    payload = json.dumps(reading_list.to_dict(), indent=2)
+    path.write_text(payload, encoding="utf-8")

bejw-0.2.0/bejw.egg-info/PKG-INFO

@@ -0,0 +1,39 @@
+Metadata-Version: 2.4
+Name: bejw
+Version: 0.2.0
+Summary: A capped reading list for links that shimmer
+Author: menisadi
+Project-URL: Homepage, https://github.com/menisadi/bejw
+Project-URL: Repository, https://github.com/menisadi/bejw
+Project-URL: Changelog, https://github.com/menisadi/bejw/blob/main/CHANGELOG.md
+Keywords: cli,reading-list,links,productivity
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+Requires-Dist: rich>=14.3.2
+Requires-Dist: typer>=0.21.1
+
+# bejw
+
+A small CLI to keep a capped reading list of links in a local JSON file.
+
+## Install
+
+```bash
+uv sync
+```
+
+## Usage
+
+```bash
+python main.py --help
+python main.py init --capacity 10
+python main.py add "https://example.com" "Example"
+python main.py list
+python main.py remove <id>
+python main.py capacity 5
+python main.py clear
+```
+
+## Storage
+
+By default, data is stored in `~/.bejw/links.json`.

bejw-0.2.0/bejw.egg-info/SOURCES.txt

@@ -0,0 +1,15 @@
+README.md
+pyproject.toml
+bejw/__init__.py
+bejw/main.py
+bejw/models.py
+bejw/render.py
+bejw/storage.py
+bejw.egg-info/PKG-INFO
+bejw.egg-info/SOURCES.txt
+bejw.egg-info/dependency_links.txt
+bejw.egg-info/entry_points.txt
+bejw.egg-info/requires.txt
+bejw.egg-info/top_level.txt
+tests/test_models.py
+tests/test_storage.py

bejw-0.2.0/bejw.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

bejw-0.2.0/bejw.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+bejw = bejw.main:app

bejw-0.2.0/bejw.egg-info/requires.txt

@@ -0,0 +1,2 @@
+rich>=14.3.2
+typer>=0.21.1

bejw-0.2.0/bejw.egg-info/top_level.txt

@@ -0,0 +1 @@
+bejw

bejw-0.2.0/pyproject.toml

@@ -0,0 +1,29 @@
+[build-system]
+requires = ["setuptools>=69", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "bejw"
+version = "0.2.0"
+description = "A capped reading list for links that shimmer"
+readme = "README.md"
+requires-python = ">=3.13"
+authors = [{ name = "menisadi" }]
+dependencies = [
+    "rich>=14.3.2",
+    "typer>=0.21.1",
+]
+keywords = ["cli", "reading-list", "links", "productivity"]
+
+[project.urls]
+Homepage = "https://github.com/menisadi/bejw"
+Repository = "https://github.com/menisadi/bejw"
+Changelog = "https://github.com/menisadi/bejw/blob/main/CHANGELOG.md"
+
+[project.scripts]
+bejw = "bejw.main:app"
+
+[dependency-groups]
+dev = [
+    "pytest>=9.0.2",
+]

bejw-0.2.0/setup.cfg

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

bejw-0.2.0/tests/test_models.py

@@ -0,0 +1,52 @@
+import pytest
+
+from bejw.models import CapacityError, Link, ReadingList
+
+
+def test_add_link_increases_size_and_returns_link() -> None:
+    reading_list = ReadingList(capacity=2)
+
+    link = reading_list.add_link("https://example.com", "Example")
+
+    assert isinstance(link, Link)
+    assert link.url == "https://example.com"
+    assert link.title == "Example"
+    assert len(reading_list.links) == 1
+
+
+def test_add_link_raises_when_capacity_reached() -> None:
+    reading_list = ReadingList(capacity=1)
+    reading_list.add_link("https://first.com", "First")
+
+    with pytest.raises(CapacityError):
+        reading_list.add_link("https://second.com", "Second")
+
+
+def test_remove_link_returns_true_when_found() -> None:
+    reading_list = ReadingList()
+    link = reading_list.add_link("https://example.com", "Example")
+
+    removed = reading_list.remove_link(link.id)
+
+    assert removed is True
+    assert reading_list.links == []
+
+
+def test_remove_link_returns_false_when_missing() -> None:
+    reading_list = ReadingList()
+
+    removed = reading_list.remove_link("missing-id")
+
+    assert removed is False
+
+
+def test_to_dict_and_from_dict_round_trip() -> None:
+    original = ReadingList(capacity=3)
+    added = original.add_link("https://example.com", "Example")
+
+    payload = original.to_dict()
+    restored = ReadingList.from_dict(payload)
+
+    assert restored.capacity == 3
+    assert len(restored.links) == 1
+    assert restored.links[0] == added

bejw-0.2.0/tests/test_storage.py

@@ -0,0 +1,27 @@
+from pathlib import Path
+
+from bejw.models import ReadingList
+from bejw.storage import load, save
+
+
+def test_load_returns_default_when_file_missing(tmp_path: Path) -> None:
+    file_path = tmp_path / "links.json"
+
+    reading_list = load(str(file_path))
+
+    assert reading_list.capacity == 10
+    assert reading_list.links == []
+
+
+def test_save_then_load_round_trip(tmp_path: Path) -> None:
+    file_path = tmp_path / "nested" / "links.json"
+    original = ReadingList(capacity=2)
+    original.add_link("https://example.com", "Example")
+
+    save(original, str(file_path))
+    loaded = load(str(file_path))
+
+    assert loaded.capacity == 2
+    assert len(loaded.links) == 1
+    assert loaded.links[0].url == "https://example.com"
+    assert loaded.links[0].title == "Example"