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

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

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

twd_m4sc0-3.0.4/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.0.4}/pyproject.toml

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

{twd_m4sc0-3.0.3 → twd_m4sc0-3.0.4}/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')

{twd_m4sc0-3.0.3 → twd_m4sc0-3.0.4}/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"""

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

@@ -8,7 +8,7 @@ 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
 
 class Mode(Enum):
     NORMAL = "normal"
@@ -177,9 +177,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.0.4}/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.0.4}/src/twd_m4sc0.egg-info/PKG-INFO

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

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
-}
-```