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

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

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

twd_m4sc0-3.1.0/README.md

@@ -0,0 +1,67 @@
+# twd
+
+A command-line tool for managing and navigating between directories in the terminal.
+
+## What it does
+
+`twd` lets you bookmark directories and quickly jump between them. Instead of typing out long paths or navigating through multiple `cd` commands, you save directories once and access them with vim-like motion bindings.
+
+Think of it as a directory hub for places you visit frequently.
+
+## Why this exists
+
+I got tired of constantly navigating through the same directory trees. This tool saves time when you're working across multiple projects or deep directory structures.
+
+No AI was used in the development of this tool. It's written by hand, contains bugs, and isn't particularly optimized. But it works for what I need, and I'm continuing to improve it.
+
+## Installation
+
+```bash
+pip install twd-m4sc0
+```
+
+## Setup
+
+To actually change directories (rather than just print paths), add this function to your `~/.bashrc` or `~/.zshrc`:
+
+```bash
+t () {
+  binary="twd"
+  local target=$($binary "$@" 3>&1 >/dev/tty)
+  if [[ -n "$target" && -d "$target" ]]; then
+    cd "$target"
+  fi
+}
+```
+
+The tool can work without this setup, but you'll only get path output instead of directory changes. This also allows for a quicker launch — instead of having to type `twd` over and over you can start it with just `t` (might conflict with other programs or functions).
+
+## Dev environment
+
+Clone the repo and install locally with 
+
+```bash
+pip install -e .
+```
+
+It is recommend to create a virtual environment and install the dependencies beforehand.
+
+## How it works
+
+`twd` uses file descriptor 3 to communicate the target directory to the shell function. The bash function captures this output and executes the `cd` command. This avoids using temporary files.
+
+The interface is built with Textual, a Python TUI framework.
+
+## Version 3
+
+This is a complete rewrite from version 2. If you're using v2.0.3 or earlier, the archived version is available [here](https://github.com/m4sc0/twd-archived).
+
+Changes include better directory handling, a proper TUI instead of hand-rolled curses code, and generally cleaner implementation.
+
+## Status
+
+The project is functional but has known issues. I'm actively developing it and fixing bugs as I find them. Check the issues tab for current problems and planned improvements. Contributions are always appreciated!
+
+## License
+
+MIT

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

@@ -1,6 +1,6 @@
 [project]
 name = "twd-m4sc0"
-version = "3.0.3"
+version = "3.1.0"
 description = "TWD by m4sc0"
 authors = [{name = "m4sc0"}]
 requires-python = ">=3.13"

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

@@ -24,10 +24,13 @@ def cli(ctx):
 
         path = TWDApp(manager=ctx.obj['manager']).run()
 
+        if not path:
+            print("Exiting...")
+            exit(0)
+
         # write to fd3
         os.write(3, bytes(str(path), "utf-8"))
-
-        pass
+        exit(0)
 
 @cli.command()
 @click.argument('path')
@@ -100,5 +103,62 @@ def list_twds(ctx):
         click.echo("No TWDs saved yet. Use 'twd save <path> <alias>' to add one.")
         return
     
+    invalid_found = False
     for entry in entries:
+        if not invalid_found and not os.path.exists(entry.path):
+            invalid_found = True
         click.echo(f"{entry.alias:20} {entry.name:30} {entry.path}")
+
+    if invalid_found:
+        click.echo(f"\nInvalid TWD paths found. Run <twd clean> to remove them.")
+
+
+@cli.command('clean')
+@click.option('--yes', '-y', is_flag=True, help="Remove all invalid entries without asking")
+@click.pass_context
+def clean(ctx, yes):
+    """
+    clean twds from invalid paths
+    """
+    manager = ctx.obj['manager']
+
+    # all entries, valid and invalid
+    entries = manager.list_all()
+
+    # only invalids
+    invalids = []
+    for entry in entries:
+        if os.path.exists(entry.path):
+            continue
+
+        invalids.append(entry)
+
+    if len(invalids) == 0:
+        click.echo("No invalid TWDs found.")
+        return
+
+    click.echo(f"Found {len(invalids)} invalid TWDs\n")
+
+    # only valid
+    valid_entries = []
+    for entry in entries:
+        if entry not in invalids:
+            valid_entries.append(entry)
+
+    # remove all
+    if yes:
+        click.echo("Removing all invalid entries...")
+        manager._write_all(valid_entries)
+        click.echo(f"Done. {len(valid_entries)} TWDs left.")
+        return
+
+    to_keep = []
+    for inv in invalids:
+        if not click.confirm(f"Do you want to remove '{inv.alias}'?", default=True):
+            # user wants to keep invalid TWD (weird but i'll allow it)
+            to_keep.append(inv)
+
+    # write a unison list of valid entries and the ones to keep
+    final_entries = valid_entries + to_keep
+    manager._write_all(final_entries)
+    click.echo(f"Done. {len(final_entries)} TWDs left.")

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

@@ -6,7 +6,6 @@ from typing import List, Optional
 from datetime import datetime
 
 from .config import Config
-from .utils import search
 
 class Entry(BaseModel):
     """Data class for a signle TWD Entry"""
@@ -27,10 +26,6 @@ class Entry(BaseModel):
     def validate_path(cls, v):
         path = Path(v).expanduser().resolve()
 
-        if not path.exists():
-            raise ValueError(f"Path does not exist: {path}")
-        if not path.is_dir():
-            raise ValueError(f"Path is not a directory: {path}")
         return path
 
     def to_csv(self) -> List[str]:
@@ -56,6 +51,7 @@ 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
@@ -81,10 +77,7 @@ class TwdManager:
             next(reader) # skip headers
 
             for row in reader:
-                try:
-                    entries.append(Entry.from_csv(row))
-                except Exception as e:
-                    print(f"Warning: skipping invalid row: {e}")
+                entries.append(Entry.from_csv(row))
 
         return entries
 

twd_m4sc0-3.1.0/src/twd/modals.py

@@ -0,0 +1,92 @@
+from textual import on
+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 twd.data import Entry
+
+class ConfirmModal(ModalScreen[bool]):
+    """A confirm modal"""
+
+    DEFAULT_CSS = """
+        ConfirmModal {
+            align: center middle;
+        }
+
+        ConfirmModal > Container {
+            width: auto;
+            height: auto;
+            border: thick $background 80%;
+            background: $surface;
+        }
+
+        ConfirmModal > Container > Label {
+            width: 100%;
+            content-align-horizontal: center;
+            margin-top: 1;
+        }
+
+        ConfirmModal > Container > Horizontal {
+            width: auto;
+            height: auto;
+        }
+
+        ConfirmModal > Container > Horizontal > Button {
+            margin: 2 4;
+        }
+    """
+
+    def __init__(
+            self, 
+            message: Union[str, None] = None,
+            confirm_text: str = "Yes",
+            cancel_text: str = "No"
+    ):
+        """
+        message: The message to display when popping the modal
+        confirm_text: Text to show for confirmation
+        cancel_text: Text to show for cancellation
+        """
+        self.message = message
+        self.confirm_text = confirm_text
+        self.cancel_text = cancel_text
+
+        super().__init__()
+
+    def compose_content(self) -> ComposeResult:
+        """
+        Abstract method for presenting custom shenanigans
+        """
+        if self.message:
+            yield Label(self.message, id="content")
+        else:
+            yield Label("Are you sure?", id="content")
+
+    def compose(self) -> ComposeResult:
+        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)
+
+class EntryDeleteModal(ConfirmModal):
+    """Confirmation modal with detailed entry information"""
+
+    def __init__(self, entry):
+        self.entry = entry
+        super().__init__(confirm_text="Delete", cancel_text="Cancel")
+
+    def compose_content(self) -> ComposeResult:
+        yield Label(f"Delete entry '{self.entry.name}'?", id="content")

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

@@ -1,4 +1,5 @@
 from enum import Enum
+from datetime import datetime
 from textual import on
 from textual.app import App, ComposeResult, Binding
 from textual.containers import HorizontalGroup, VerticalScroll
@@ -8,7 +9,8 @@ from textual.color import Color
 
 from twd.config import Config
 from twd.data import TwdManager
-from twd.utils import search, linear_search
+from twd.utils import fuzzy_search, linear_search
+from twd.modals import ConfirmModal, EntryDeleteModal
 
 class Mode(Enum):
     NORMAL = "normal"
@@ -28,6 +30,7 @@ class TWDApp(App):
 
             # modify
             Binding("/", "enter_search_mode", "Search"),
+            Binding("d", "delete_entry", "Delete"),
             Binding("escape", "enter_normal_mode", "Normal", show=False),
             # TODO: edit
             # TODO: rename
@@ -77,7 +80,7 @@ class TWDApp(App):
 
         # add headers
         table = self.query_one(DataTable)
-        table.add_columns(*self.manager.CSV_HEADERS)
+        table.add_columns(*self.manager.CSV_HEADERS_FANCY)
         
         self._populate_table()
 
@@ -93,7 +96,7 @@ class TWDApp(App):
         
         # fill data
         for entry in entries:
-            table.add_row(entry.alias, str(entry.path), entry.name, entry.created_at)
+            table.add_row(entry.alias, str(entry.path), entry.name, entry.created_at.strftime("%Y-%m-%d %H:%M:%S"))
 
     def watch_mode(self, old_mode: Mode, new_mode: Mode) -> None:
         """
@@ -128,8 +131,11 @@ class TWDApp(App):
         """
         table = self.query_one(DataTable)
 
-        current_row = table.cursor_coordinate.row
-        next_row = (current_row + 1) % table.row_count
+        try:
+            current_row = table.cursor_coordinate.row
+            next_row = (current_row + 1) % table.row_count
+        except ZeroDivisionError as e:
+            return
 
         table.move_cursor(row=next_row)
 
@@ -139,8 +145,11 @@ class TWDApp(App):
         """
         table = self.query_one(DataTable)
         
-        current_row = table.cursor_coordinate.row
-        prev_row = (current_row - 1) % table.row_count
+        try:
+            current_row = table.cursor_coordinate.row
+            prev_row = (current_row - 1) % table.row_count
+        except ZeroDivisionError as e:
+            return
 
         table.move_cursor(row=prev_row)
 
@@ -160,6 +169,39 @@ class TWDApp(App):
             return
         self.mode = Mode.NORMAL
 
+    def action_delete_entry(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)
+
+        def check_delete(decision: bool | None) -> None:
+            """
+            open modal and return the decision
+            """
+            if not decision:
+                return
+
+            self.manager.remove(alias)
+
+            self._populate_table()
+
+            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_exit(self) -> None:
         self.exit()
 
@@ -177,9 +219,13 @@ class TWDApp(App):
 
         # TODO: filter entries and repopulate table
 
-        search_result = linear_search(query, all_entries)
+        if query is None:
+            self._populate_table()
+            return
+
+        search_result = fuzzy_search(query, all_entries)
 
-        filtered = [entry for entry in all_entries if entry.alias in search_result]
+        filtered = [item[0] for item in search_result]
 
         self._populate_table(filtered)
 

{twd_m4sc0-3.0.3 → twd_m4sc0-3.1.0}/src/twd/utils.py

@@ -1,39 +1,40 @@
 from rapidfuzz import fuzz
 from typing import List
 
-FUZZY_THRESHOLD = 50
-
 def normalize(name) -> str:
     return name.lower().replace('-', ' ').replace('_', ' ')
 
-def search(query, items, threshold = 50) -> List:
+def fuzzy_search(query, items, threshold = 50) -> List:
     """
     query: search input
     items: list of (alias, name)
+    threshold: threshold score over which the entries are selected
 
-    returns: list of (alias, name, score)
+    returns: list of (entry, score)
     """
 
     # return all items if query is empty
     if not query:
-        return [(alias, name, 100) for alias, name in items]
+        return [(e, 100) for e in items]
 
     normalized_query = normalize(query)
     results = []
 
     # filtering
-    for alias, name in items:
-        alias_score = fuzz.WRatio(normalized_query, normalize(alias))
-        name_score = fuzz.WRatio(normalized_query, normalize(name))
+    for entry in items:
+        alias, name = normalize(entry.alias), normalize(entry.name)
+
+        alias_score = fuzz.ratio(normalized_query, alias)
+        name_score = fuzz.ratio(normalized_query, name)
 
         # choose higher score
         best_score = max(alias_score, name_score)
 
         # filter out low scores
-        if best_score >= threshold:
-            results.append((alias, name, best_score))
+        if best_score > threshold:
+            results.append((entry, best_score))
 
-    results.sort(key=lambda x: x[2], reverse=True)
+    results.sort(key=lambda x: x[1], reverse=True)
 
     return results
 

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

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

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

@@ -4,6 +4,7 @@ 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

twd_m4sc0-3.0.3/README.md

@@ -1,34 +0,0 @@
-# twd-m4sc0
-
-> [!IMPORTANT]
-> This is complete rewrite of the program `twd`. If you're using `<=v2.0.3` please make sure to upgrade to the newest major release. The archived version v2 can be viewed [here](https://github.com/m4sc0/twd-archived).
-
-> twd-m4sc0 / twd is a command-line tool that allows you to temporarily save a working directory and easily navigate back to it. It's designed for developers and users who frequently need to switch between directories in the terminal.
-
-That's what it was supposed to do at the start. Now it's more like a hub for your frequently visited directories. You can use it like a bookmark manager or for the quickest method of changing between directories that you can find.
-
-There are quite a few things I wanna make better this time.
-
-### Better directory changing
-
-Previously twd wrote to a temp file, then a bash function used the contents if that file exists, cd's to the dir and deletes the file again. This time around I'm going a different way. I found the method `os.write(3, path)` which can write to [file descriptors](https://en.wikipedia.org/wiki/File_descriptor) directly. This is the same way stdout and stderr are handled in the background (i think). But i'm using a fourth (0 = stdin, 1 = stdout, 2 = stderr), unused FD to write to. This is then captured in the bash function separately from the stdout. 
-
-### Improved TUI
-
-For some reason I thought writing a whole UI system using [curses](https://de.wikipedia.org/wiki/Curses) was a good idea. Well, now at least I know better and can say that I won't do that ever again.
-
-I'll use [Textual](https://textual.textualize.io/) now.
-
-### Setup
-
-It's possible to use TWD without the feature of cd'ing anywhere. But that's kinda lame lol. To make sure it works as intended, copy the following snippet into something like a `~/.bashrc` file.
-
-```bash
-t () {
-  binary="twd"
-  local target=$($binary "$@" 3>&1 >/dev/tty)
-  if [[ -n "$target" && -d "$target" ]]; then
-    cd "$target"
-  fi
-}
-```