twd-m4sc0 3.1.0__tar.gz → 3.1.2__tar.gz

{twd_m4sc0-3.1.0 → twd_m4sc0-3.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: twd-m4sc0
-Version: 3.1.0
+Version: 3.1.2
 Summary: TWD by m4sc0
 Author: m4sc0
 License: MIT

{twd_m4sc0-3.1.0 → twd_m4sc0-3.1.2}/pyproject.toml

@@ -1,6 +1,7 @@
 [project]
 name = "twd-m4sc0"
-version = "3.1.0"
+# version = "3.1.0"
+dynamic = ["version"]
 description = "TWD by m4sc0"
 authors = [{name = "m4sc0"}]
 requires-python = ">=3.13"
@@ -32,3 +33,6 @@ where = ["src"]
 
 [tool.setuptools.package-data]
 twd = ["*.tcss"]
+
+[tool.setuptools.dynamic]
+version = {attr = "twd.__version__"}

twd_m4sc0-3.1.2/src/twd/__init__.py

@@ -0,0 +1 @@
+__version__ = "3.1.2"

{twd_m4sc0-3.1.0 → twd_m4sc0-3.1.2}/src/twd/cli.py

@@ -8,7 +8,7 @@ from .tui import TWDApp
 
 @click.group(invoke_without_command=True)
 @click.pass_context
-@click.version_option(version=__version__)
+@click.version_option(version=__version__, prog_name="twd")
 def cli(ctx):
     """
     TWD - Temp / Tracked Working Directory
@@ -16,7 +16,7 @@ def cli(ctx):
     ctx.ensure_object(dict)
 
     ctx.obj['config'] = Config.load() # load config
-    ctx.obj['manager'] = TwdManager(ctx.obj['config'].data_path)
+    ctx.obj['manager'] = TwdManager(ctx.obj['config']) # pass config
 
     # if no subcommand was provided, launch TUI
     if ctx.invoked_subcommand is None:
@@ -39,7 +39,18 @@ def cli(ctx):
 @click.pass_context
 def save(ctx, path, alias, name):
     """
-    Save a new twd with PATH, [opt] ALIAS and [opt] NAME
+    Save a new TWD with an Alias (UUID like) and Name
+
+    Examples:
+
+        twd save ./Movies movies Media
+
+        twd save / root "Root Directory -- /dev/sda3"
+
+        twd save . finances-q1 "Finance Documents Q1"
+
+    The naming conventions for the alias align with kebab-casing.
+    There are no naming conventions for the name.
     """
     manager: TwdManager = ctx.obj['manager']
 
@@ -61,7 +72,13 @@ def save(ctx, path, alias, name):
 @click.pass_context
 def get(ctx, alias):
     """
-    get path for ALIAS
+    cd into a directory by the given Alias
+
+    Examples:
+
+        twd get movies
+
+    There's really not much to it.
     """
     manager = ctx.obj['manager']
 
@@ -81,7 +98,13 @@ def get(ctx, alias):
 @click.pass_context
 def remove(ctx, alias):
     """
-    remove TWD by ALIAS
+    Remove TWD by the given Alias
+
+    Examples:
+
+        twd remove movies
+
+    That's it.
     """
     manager = ctx.obj['manager']
     
@@ -95,7 +118,9 @@ def remove(ctx, alias):
 @cli.command('list')
 @click.pass_context
 def list_twds(ctx):
-    """List all TWDs"""
+    """
+    List all TWDs
+    """
     manager = ctx.obj['manager']
     
     entries = manager.list_all()
@@ -118,7 +143,10 @@ def list_twds(ctx):
 @click.pass_context
 def clean(ctx, yes):
     """
-    clean twds from invalid paths
+    Clean the records of rogue TWDs
+
+    Sometimes it's possible that TWDs are not properly cleaned up.
+    That's what this subcommand does.
     """
     manager = ctx.obj['manager']
 

{twd_m4sc0-3.1.0 → twd_m4sc0-3.1.2}/src/twd/config.py

@@ -1,7 +1,7 @@
 
-
 from pathlib import Path
 from pydantic import BaseModel, Field, validator
+from enum import Enum
 import json
 import os
 import sys
@@ -32,10 +32,28 @@ def get_data_path() -> Path:
 
     return data_dir / "data.csv"
 
+class SortField(str, Enum):
+    ALIAS = "alias"
+    PATH = "path"
+    NAME = "name"
+    CREATED_AT = "created_at"
+
+class SortDirection(str, Enum):
+    ASC = "asc"
+    DESC = "desc"
+
+class SortOrderSetting(BaseModel):
+    field: SortField = SortField.CREATED_AT
+    direction: SortDirection = SortDirection.ASC
+
+class Settings(BaseModel):
+    sort_order: SortOrderSetting = Field(default_factory=SortOrderSetting)
+
 class Config(BaseModel):
     """App configuration"""
 
     data_path: Path = Field(default_factory=get_data_path)
+    settings: Settings = Field(default_factory=Settings)
     
     @validator("data_path")
     def validate_path(cls, v):

{twd_m4sc0-3.1.0 → twd_m4sc0-3.1.2}/src/twd/data.py

@@ -5,7 +5,7 @@ from pydantic import BaseModel, Field, validator
 from typing import List, Optional
 from datetime import datetime
 
-from .config import Config
+from .config import Config, SortDirection
 
 class Entry(BaseModel):
     """Data class for a signle TWD Entry"""
@@ -15,6 +15,17 @@ class Entry(BaseModel):
     name: str = Field(..., min_length=3)
     created_at: datetime = Field(default_factory=datetime.now)
 
+    def __eq__(self, other) -> bool:
+        """Compare entries based on their values"""
+        if not isinstance(other, Entry):
+            return NotImplemented
+
+        return (
+                self.alias == other.alias
+                and self.path == other.path
+                and self.name == other.name
+                )
+
     @validator("alias")
     def validate_alias(cls, v):
         if not v.replace("_", "").replace("-", "").isalnum():
@@ -47,23 +58,33 @@ class Entry(BaseModel):
                 created_at=datetime.fromisoformat(row[3])
                 )
 
+    @classmethod
+    def from_values(cls, alias, path, name, created_at) -> "Entry":
+        """create from values"""
+        return cls(
+                alias=alias,
+                path=path,
+                name=name,
+                created_at=created_at
+                )
+
 class TwdManager:
     """twd entry manager stored in csv"""
 
     CSV_HEADERS = ["alias", "path", "name", "created_at"]
     CSV_HEADERS_FANCY = ["Alias", "Path", "Description", "Created at"]
 
-    def __init__(self, csv_path: Path):
-        self.csv_path = csv_path
+    def __init__(self, config: Config): # accept config as argument
+        self.config = config
         self._ensure_csv_exists()
         self.cwd = str(Path.cwd())
 
     def _ensure_csv_exists(self) -> None:
         """create csv headers"""
-        if not self.csv_path.exists():
-            self.csv_path.parent.mkdir(parents=True, exist_ok=True) 
+        if not self.config.data_path.exists():
+            self.config.data_path.parent.mkdir(parents=True, exist_ok=True) 
 
-            with open(self.csv_path, 'w', newline='') as f:
+            with open(self.config.data_path, 'w', newline='') as f:
                 writer = csv.writer(f)
                 writer.writerow(self.CSV_HEADERS)
 
@@ -71,7 +92,7 @@ class TwdManager:
         """read all entries"""
         entries = []
 
-        with open(self.csv_path, 'r', newline='') as f:
+        with open(self.config.data_path, 'r', newline='') as f:
             reader = csv.reader(f)
 
             next(reader) # skip headers
@@ -82,7 +103,7 @@ class TwdManager:
         return entries
 
     def _write_all(self, entries: List[Entry]) -> None:
-        with open(self.csv_path, 'w', newline='') as f:
+        with open(self.config.data_path, 'w', newline='') as f:
             writer = csv.writer(f)
             writer.writerow(self.CSV_HEADERS)
 
@@ -115,6 +136,22 @@ class TwdManager:
 
         return None
 
+    def update(self, alias: str, entry: Entry) -> bool:
+        """update TWD by alias"""
+        if not self.exists(alias):
+            return False
+
+        entries = self._read_all()
+
+        # find and upate
+        for i, e in enumerate(entries):
+            if e.alias == alias.lower():
+                entries[i] = entry
+                break
+
+        self._write_all(entries)
+        return True
+
     def remove(self, alias: str) -> None:
         """remove entry by alias"""
         entries = self._read_all()
@@ -130,7 +167,9 @@ class TwdManager:
     def list_all(self) -> List[Entry]:
         entries = self._read_all()
 
-        return sorted(entries, key=lambda e: e.created_at)
+        sort_config = self.config.settings.sort_order
+        reverse = (sort_config.direction == SortDirection.DESC)
+        return sorted(entries, key=lambda e: getattr(e, sort_config.field.value), reverse=reverse)
 
     def exists(self, alias: str) -> bool:
         return self.get(alias) is not None

twd_m4sc0-3.1.2/src/twd/modals/__init__.py

@@ -0,0 +1,4 @@
+from twd.modals.confirm import ConfirmModal, EntryDeleteModal
+from twd.modals.edit import EditEntryModal
+
+__all__ = ["ConfirmModal", "EntryDeleteModal", "EditEntryModal"]

twd_m4sc0-3.1.0/src/twd/modals.py → twd_m4sc0-3.1.2/src/twd/modals/confirm.py

@@ -3,11 +3,13 @@ from textual.app import ComposeResult
 from textual.screen import ModalScreen
 from textual.containers import Container, Horizontal
 from textual.widgets import Button, Label
-from typing import Union
+from typing import Union, TypeVar, Generic
 
 from twd.data import Entry
 
-class ConfirmModal(ModalScreen[bool]):
+T = TypeVar('T')
+
+class ConfirmModal(ModalScreen[T], Generic[T]):
     """A confirm modal"""
 
     DEFAULT_CSS = """
@@ -42,7 +44,9 @@ class ConfirmModal(ModalScreen[bool]):
             self, 
             message: Union[str, None] = None,
             confirm_text: str = "Yes",
-            cancel_text: str = "No"
+            cancel_text: str = "No",
+            confirm_value: T | None = None,
+            cancel_value: T | None = None,
     ):
         """
         message: The message to display when popping the modal
@@ -53,6 +57,9 @@ class ConfirmModal(ModalScreen[bool]):
         self.confirm_text = confirm_text
         self.cancel_text = cancel_text
 
+        self.confirm_value = confirm_value
+        self.cancel_value = cancel_value
+
         super().__init__()
 
     def compose_content(self) -> ComposeResult:
@@ -68,18 +75,16 @@ class ConfirmModal(ModalScreen[bool]):
         with Container():
             yield from self.compose_content()
             with Horizontal():
-                yield Button(self.cancel_text, id="no", variant="error")
-                yield Button(self.confirm_text, id="yes", variant="success")
-
-    @on(Button.Pressed, "#no")
-    def no_decision(self) -> None:
-        """decision no"""
-        self.dismiss(False)
-
-    @on(Button.Pressed, "#yes")
-    def yes_decision(self) -> None:
-        """decision yes"""
-        self.dismiss(True)
+                yield Button(self.cancel_text, id="cancel", variant="error")
+                yield Button(self.confirm_text, id="confirm", variant="success")
+
+    @on(Button.Pressed, "#cancel")
+    def cancel_pressed(self) -> None:
+        self.dismiss(self.cancel_value)
+
+    @on(Button.Pressed, "#confirm")
+    def confirm_pressed(self) -> None:
+        self.dismiss(self.confirm_value)
 
 class EntryDeleteModal(ConfirmModal):
     """Confirmation modal with detailed entry information"""

twd_m4sc0-3.1.2/src/twd/modals/edit.py

@@ -0,0 +1,52 @@
+from textual import on
+from textual.app import ComposeResult
+from textual.containers import Container, Horizontal
+from textual.widgets import Button, Label, Input
+
+from twd.data import Entry
+from twd.modals import ConfirmModal
+
+class EditEntryModal(ConfirmModal[Entry | None]):
+    """A modal to edit an existing entry"""
+
+    DEFAULT_CSS = """
+        Label {
+            width: 100%;
+            text-align: left;
+        }
+        Input {
+            margin: 1;
+        }
+    """
+
+    def __init__(self, entry):
+        """
+        entry: the entry to edit
+        """
+        self.entry = Entry.from_values(entry.alias, entry.path, entry.name, entry.created_at)
+
+        super().__init__(
+                confirm_text="Save",
+                cancel_text="Discard",
+                confirm_value=self.entry,
+                )
+
+    def compose_content(self) -> ComposeResult:
+        yield Label(f"Edit Entry", id="title")
+
+        yield Label("Alias")
+        yield Input(value=self.entry.alias, id="alias", disabled=True)
+        yield Label("Path")
+        yield Input(value=str(self.entry.path), id="path")
+        yield Label("Name")
+        yield Input(value=self.entry.name, id="name")
+    
+    @on(Input.Changed, "#path")
+    def on_path_change(self, event: Input.Changed) -> None:
+        self.entry.path = event.value
+    
+    @on(Input.Changed, "#name")
+    def on_name_change(self, event: Input.Changed) -> None:
+        self.entry.name = event.value
+
+        

{twd_m4sc0-3.1.0 → twd_m4sc0-3.1.2}/src/twd/tui.py

@@ -8,9 +8,9 @@ from textual.widgets import Button, Digits, Footer, Header, DataTable, Label, Ru
 from textual.color import Color
 
 from twd.config import Config
-from twd.data import TwdManager
+from twd.data import TwdManager, Entry
 from twd.utils import fuzzy_search, linear_search
-from twd.modals import ConfirmModal, EntryDeleteModal
+from twd.modals import ConfirmModal, EntryDeleteModal, EditEntryModal
 
 class Mode(Enum):
     NORMAL = "normal"
@@ -29,9 +29,10 @@ class TWDApp(App):
             Binding("k", "cursor_up", "Up"),
 
             # modify
-            Binding("/", "enter_search_mode", "Search"),
-            Binding("d", "delete_entry", "Delete"),
-            Binding("escape", "enter_normal_mode", "Normal", show=False),
+            Binding("/", "slash_key", "Search"),
+            Binding("d", "d_key", "Delete"),
+            Binding("e", "e_key", "Edit"),
+            Binding("escape", "escape_key", "Normal", show=False),
             # TODO: edit
             # TODO: rename
 
@@ -43,6 +44,7 @@ class TWDApp(App):
         ]
 
     mode: Mode = reactive(Mode.NORMAL)
+    search_results = None
 
     def __init__(self, manager: TwdManager, *args, **kwargs):
         self.manager = manager
@@ -98,6 +100,19 @@ class TWDApp(App):
         for entry in entries:
             table.add_row(entry.alias, str(entry.path), entry.name, entry.created_at.strftime("%Y-%m-%d %H:%M:%S"))
 
+    def _current_row_entry(self) -> Entry:
+        table = self.query_one(DataTable)
+
+        # get row
+        row_key = table.coordinate_to_cell_key(table.cursor_coordinate).row_key
+        row_data = table.get_row(row_key)
+        alias = row_data[0]
+
+        # get entry
+        entry = self.manager.get(alias)
+
+        return entry
+
     def watch_mode(self, old_mode: Mode, new_mode: Mode) -> None:
         """
         react to mode changes
@@ -153,7 +168,7 @@ class TWDApp(App):
 
         table.move_cursor(row=prev_row)
 
-    def action_enter_search_mode(self) -> None:
+    def action_slash_key(self) -> None:
         """
         enter search mode
         """
@@ -161,30 +176,25 @@ class TWDApp(App):
             return
         self.mode = Mode.SEARCH
 
-    def action_enter_normal_mode(self) -> None:
+    def action_escape_key(self) -> None:
         """
         enter normal mode
         """
         if self.mode == Mode.NORMAL:
+            if self.search_results is not None:
+                self._populate_table()
+                self.search_results = None
             return
         self.mode = Mode.NORMAL
 
-    def action_delete_entry(self) -> None:
+    def action_d_key(self) -> None:
         """
         open confirm modal and delete entry if yes
         """
         if not self.mode == Mode.NORMAL:
             return
 
-        table = self.query_one(DataTable)
-
-        # get row
-        row_key = table.coordinate_to_cell_key(table.cursor_coordinate).row_key
-        row_data = table.get_row(row_key)
-        alias = row_data[0]
-
-        # get entry
-        entry = self.manager.get(alias)
+        entry = self._current_row_entry()
 
         def check_delete(decision: bool | None) -> None:
             """
@@ -199,9 +209,29 @@ class TWDApp(App):
 
             self.notify(f"Removed entry \"{entry.name}\"")
 
-        # self.push_screen(ConfirmModal(message=f"Are you sure want to delete '{entry.alias}'?"), check_delete)
         self.push_screen(EntryDeleteModal(entry), check_delete)
 
+    def action_e_key(self) -> None:
+        """
+        open edit modal and edit entry in place
+        """
+        entry = self._current_row_entry()
+
+        def save_new_entry(new_entry: Entry | None) -> None:
+            if not new_entry or entry == new_entry:
+                # user hit 'Discard'
+                # no changes so no update
+                self.notify(f"No changes")
+                return
+
+            self.notify(f"Updated TWD '{new_entry.alias}'")
+
+            self.manager.update(new_entry.alias, new_entry)
+            self.manager._write_all(self.manager._read_all())
+            self._populate_table()
+
+        self.push_screen(EditEntryModal(entry), save_new_entry)
+
     def action_exit(self) -> None:
         self.exit()
 
@@ -228,6 +258,7 @@ class TWDApp(App):
         filtered = [item[0] for item in search_result]
 
         self._populate_table(filtered)
+        self.search_results = filtered
 
     @on(Input.Submitted, "#search-input")
     def on_search_submitted(self, e: Input.Submitted) -> None:
@@ -238,6 +269,7 @@ class TWDApp(App):
             return
 
         self.mode = Mode.NORMAL
+        self._populate_table(self.search_results)
 
         self.query_one(DataTable).focus()
 
@@ -250,12 +282,7 @@ class TWDApp(App):
         table = event.data_table
         row_key = event.row_key
 
-        # get row
-        row_data = table.get_row(row_key)
-        alias = row_data[0]
-
-        # get entry
-        entry = self.manager.get(alias)
+        entry = self._current_row_entry()
 
         self.notify(f"Selected: {entry.alias} -> {entry.path}")
 

{twd_m4sc0-3.1.0 → twd_m4sc0-3.1.2}/src/twd_m4sc0.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: twd-m4sc0
-Version: 3.1.0
+Version: 3.1.2
 Summary: TWD by m4sc0
 Author: m4sc0
 License: MIT

{twd_m4sc0-3.1.0 → twd_m4sc0-3.1.2}/src/twd_m4sc0.egg-info/SOURCES.txt

@@ -4,10 +4,12 @@ src/twd/__init__.py
 src/twd/cli.py
 src/twd/config.py
 src/twd/data.py
-src/twd/modals.py
 src/twd/tui.py
 src/twd/tui.tcss
 src/twd/utils.py
+src/twd/modals/__init__.py
+src/twd/modals/confirm.py
+src/twd/modals/edit.py
 src/twd_m4sc0.egg-info/PKG-INFO
 src/twd_m4sc0.egg-info/SOURCES.txt
 src/twd_m4sc0.egg-info/dependency_links.txt

twd_m4sc0-3.1.0/src/twd/__init__.py

@@ -1,6 +0,0 @@
-from importlib.metadata import version, PackageNotFoundError
-
-try:
-    __version__ = version("twd")
-except PackageNotFoundError as e:
-    __version__ = "unknown"