treex-cli 0.1.1__tar.gz → 0.1.3__tar.gz

{treex_cli-0.1.1/treex_cli.egg-info → treex_cli-0.1.3}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: treex-cli
-Version: 0.1.1
-Summary: List directory contents in a tree format with file metadata.
+Version: 0.1.3
+Summary: List directory contents as a tree with file metadata
 Author: Corey Goldberg
 Maintainer: Corey Goldberg
 License-Expression: MIT
@@ -25,7 +25,7 @@ Dynamic: license-file
 
 # treex
 
-## List directory contents in a tree format with file metadata.
+## List directory contents as a tree with file metadata
 
 - Copyright (c) 2026 [Corey Goldberg][github-profile]
 - Development: [GitHub][github-repo]
@@ -36,18 +36,14 @@ Dynamic: license-file
 
 ## About
 
-`treex` is a command-line utility (similar to [tree][tree-home]) that recursively
-scans a directory and prints its contents as a tree using Unicode box-drawing
-characters. File names include their human-readable size and, optionally,
-modification time. Text files also include their line count, while binary and
-unreadable files are marked with their type. When Git is installed, it respects
-`.gitignore` rules.
+`treex` is a command-line utility that recursively scans a directory and
+displays its contents as a tree along with file metadata.
 
-Requirements:
-
-- Python 3.10+
-- Git 2.0+ (optional)
-- UTF-8-compatible terminal
+- File names show human-readable sizes
+- Text files show line counts
+- Binary and unreadable files show their type
+- Modification timestamps are optional
+- Respects `.gitignore` rules when Git is installed
 
 ----
 
@@ -82,6 +78,14 @@ Requirements:
 
 ----
 
+## Requirements
+
+- Python 3.10+
+- Git 2.0+ (optional)
+- UTF-8-compatible terminal
+
+----
+
 ## Installation
 
 Install `treex` from [PyPI][pypi-home] using either `pip` or `pipx`:
@@ -95,9 +99,9 @@ Install `treex` from [PyPI][pypi-home] using either `pip` or `pipx`:
 
 ```
 $ treex --help
-usage: treex [-h] [-a] [-m] [-s] [-w N] [directory]
+usage: treex [-h] [-a] [-m] [-s] [directory]
 
-List directory contents in a tree format with file metadata.
+List directory contents as a tree with file metadata.
 
 positional arguments:
   directory       directory to scan (default: current directory)
@@ -107,7 +111,6 @@ options:
   -a, --all       show all files (including those ignored by Git)
   -m, --modified  show file modification times
   -s, --summary   show summary only
-  -w, --width N   starting column for file metadata (default: 50)
 ```
 
 ----
@@ -120,4 +123,3 @@ options:
 [github-repo]: https://github.com/cgoldberg/treex
 [pypi-home]: https://pypi.org/project/treex-cli
 [mit-license]: https://raw.githubusercontent.com/cgoldberg/treex/refs/heads/main/LICENSE
-[tree-home]: https://oldmanprogrammer.net/source.php?dir=projects/tree

{treex_cli-0.1.1 → treex_cli-0.1.3}/README.md

@@ -1,6 +1,6 @@
 # treex
 
-## List directory contents in a tree format with file metadata.
+## List directory contents as a tree with file metadata
 
 - Copyright (c) 2026 [Corey Goldberg][github-profile]
 - Development: [GitHub][github-repo]
@@ -11,18 +11,14 @@
 
 ## About
 
-`treex` is a command-line utility (similar to [tree][tree-home]) that recursively
-scans a directory and prints its contents as a tree using Unicode box-drawing
-characters. File names include their human-readable size and, optionally,
-modification time. Text files also include their line count, while binary and
-unreadable files are marked with their type. When Git is installed, it respects
-`.gitignore` rules.
+`treex` is a command-line utility that recursively scans a directory and
+displays its contents as a tree along with file metadata.
 
-Requirements:
-
-- Python 3.10+
-- Git 2.0+ (optional)
-- UTF-8-compatible terminal
+- File names show human-readable sizes
+- Text files show line counts
+- Binary and unreadable files show their type
+- Modification timestamps are optional
+- Respects `.gitignore` rules when Git is installed
 
 ----
 
@@ -57,6 +53,14 @@ Requirements:
 
 ----
 
+## Requirements
+
+- Python 3.10+
+- Git 2.0+ (optional)
+- UTF-8-compatible terminal
+
+----
+
 ## Installation
 
 Install `treex` from [PyPI][pypi-home] using either `pip` or `pipx`:
@@ -70,9 +74,9 @@ Install `treex` from [PyPI][pypi-home] using either `pip` or `pipx`:
 
 ```
 $ treex --help
-usage: treex [-h] [-a] [-m] [-s] [-w N] [directory]
+usage: treex [-h] [-a] [-m] [-s] [directory]
 
-List directory contents in a tree format with file metadata.
+List directory contents as a tree with file metadata.
 
 positional arguments:
   directory       directory to scan (default: current directory)
@@ -82,7 +86,6 @@ options:
   -a, --all       show all files (including those ignored by Git)
   -m, --modified  show file modification times
   -s, --summary   show summary only
-  -w, --width N   starting column for file metadata (default: 50)
 ```
 
 ----
@@ -95,4 +98,3 @@ options:
 [github-repo]: https://github.com/cgoldberg/treex
 [pypi-home]: https://pypi.org/project/treex-cli
 [mit-license]: https://raw.githubusercontent.com/cgoldberg/treex/refs/heads/main/LICENSE
-[tree-home]: https://oldmanprogrammer.net/source.php?dir=projects/tree

{treex_cli-0.1.1 → treex_cli-0.1.3}/pyproject.toml

@@ -4,8 +4,8 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "treex-cli"
-version = "0.1.1"
-description="List directory contents in a tree format with file metadata."
+version = "0.1.3"
+description="List directory contents as a tree with file metadata"
 license = "MIT"
 license-files = ["LICENSE"]
 authors = [{name = "Corey Goldberg"}]
@@ -68,7 +68,7 @@ ignore = [
 fixable = ["ALL"]
 
 [tool.ruff.lint.per-file-ignores]
-"**/test_*.py" = ["S101", "S108"]
+"**/test_*.py" = ["S101", "S108", "SLF001"]
 
 [tool.ruff.format]
 docstring-code-format = true

{treex_cli-0.1.1 → treex_cli-0.1.3}/treex.py

@@ -2,21 +2,14 @@
 # SPDX-License-Identifier: MIT
 
 
-"""List directory contents in a tree-like format with file metadata.
+"""List directory contents as a tree with file metadata.
 
-The directory tree is rendered using Unicode box-drawing characters. File names are
-displayed with their human-readable size and, optionally, modification time. Text
-files also include their line count. Binary and unreadable files are marked with
-their type.
+The directory tree is rendered using Unicode box-drawing characters.
 
 When run inside a Git repository, files and directories ignored by Git
 are automatically excluded using Git's own ignore rules. If Git is not
 installed, or the directory is not part of a Git repository, the
 filesystem is scanned normally without Git filtering.
-
-Use --all to disable Git ignore filtering and show all files.
-Use --width to control the column at which file metadata starts.
-Use --modified to show file modification times.
 """
 
 import argparse
@@ -25,8 +18,6 @@ from contextlib import suppress
 from datetime import datetime
 from pathlib import Path
 
-DEFAULT_METADATA_COLUMN = 50
-
 
 class GitIgnore:
     """Use Git's ignore rules when available."""
@@ -69,7 +60,7 @@ class GitIgnore:
             return result.returncode == 0
 
 
-def format_size(size):  # noqa: RET503
+def _format_size(size):  # noqa: RET503
     """Format bytes as a human-readable size."""
     units = ["B", "KB", "MB", "GB", "TB"]
     for unit in units:
@@ -80,12 +71,12 @@ def format_size(size):  # noqa: RET503
         size /= 1024
 
 
-def format_modified(timestamp):
+def _format_modified(timestamp):
     """Format a modification timestamp."""
     return datetime.fromtimestamp(timestamp).strftime("%Y-%m-%d %H:%M")
 
 
-def is_binary_file(path, chunk_size=8192):
+def _is_binary_file(path, chunk_size=8192):
     """Check if the file appears to be binary."""
     try:
         with path.open("rb") as f:
@@ -106,7 +97,7 @@ def is_binary_file(path, chunk_size=8192):
         return True
 
 
-def count_lines(path):
+def _count_lines(path):
     """Count lines without loading the entire file into memory."""
     try:
         with path.open("rb") as f:
@@ -115,93 +106,115 @@ def count_lines(path):
         return None
 
 
-def file_info(path):
-    """Get file info."""
+def _file_metadata(path):
+    """Get file metadata."""
     try:
         stat = path.stat()
         size = stat.st_size
-        modified = format_modified(stat.st_mtime)
+        modified = _format_modified(stat.st_mtime)
     except OSError:
         return "?", "[unreadable]", 0, None
-    size_text = format_size(size)
-    if is_binary_file(path):
+    size_text = _format_size(size)
+    if _is_binary_file(path):
         return size_text, "[binary]", size, modified
-    lines = count_lines(path)
+    lines = _count_lines(path)
     if lines is None:
         return size_text, "[unreadable]", size, modified
     return size_text, f"{lines:,} lines", size, modified
 
 
-def print_tree(
-    directory,
-    prefix="",
-    stats=None,
-    gitignore=None,
-    width=DEFAULT_METADATA_COLUMN,
-    show_modified=False,
-    show_tree=True,
-):
-    """Recursively print the directory tree."""
-
-    def display(message):
-        if show_tree:
-            print(message)
-
-    if stats is None:
-        stats = {
-            "directories": 0,
-            "files": 0,
-            "total_size": 0,
-        }
-    path = Path(directory)
+def _get_tree_entries(path, gitignore):
+    """Get entries to include in the tree."""
     try:
         entries = list(path.iterdir())
     except PermissionError:
-        display(prefix + "└── [permission denied]")
-        return stats
+        return None
     # Filter ignored entries and Git's internal directory
-    visible_entries = [
+    entries = [
         entry
         for entry in entries
-        if not gitignore or (entry.name != ".git" and not gitignore.ignored(entry))
+        if not entry.is_symlink()
+        and (not gitignore or (entry.name != ".git" and not gitignore.ignored(entry)))
     ]
-    # Sort directories before files, group symlinks
-    # by target type, and sort names case-insensitive.
-    visible_entries.sort(key=lambda p: (p.is_file(), p.name.casefold()))
-    for index, entry in enumerate(visible_entries):
-        is_last = index == len(visible_entries) - 1
+    # Group directories first and sort names case-insensitive
+    entries.sort(key=lambda p: (p.is_file(), p.name.casefold()))
+    return entries
+
+
+def _collect_tree(
+    path,
+    prefix,
+    stats,
+    gitignore,
+    rows,
+    show_modified,
+):
+    """Walk the tree once and collect the output rows."""
+    entries = _get_tree_entries(path, gitignore)
+    if entries is None:
+        rows.append((prefix + "└── [permission denied]", None))
+        return
+    for index, entry in enumerate(entries):
+        is_last = index == len(entries) - 1
         connector = "└── " if is_last else "├── "
+        tree_name = prefix + connector + entry.name
         if entry.is_dir():
             stats["directories"] += 1
-            display(f"{prefix}{connector}{entry.name}")
+            rows.append((tree_name, None))
+            # Indent nested entries, preserving the tree's vertical branch
             extension = "    " if is_last else "│   "
-            print_tree(
+            _collect_tree(
                 entry,
                 prefix + extension,
                 stats,
                 gitignore,
-                width,
+                rows,
                 show_modified,
-                show_tree,
             )
         elif entry.is_file():
             stats["files"] += 1
-            size_text, info, size, modified = file_info(entry)
+            size_text, info, size, modified = _file_metadata(entry)
             stats["total_size"] += size
-            # The complete tree/name portion is padded to the
-            # specified width so metadata lines up vertically.
-            tree_name = prefix + connector + entry.name
-            output = f"{tree_name:<{width}}{size_text:>10}    {info}"
-            if show_modified and modified is not None:
+            timestamp = modified if show_modified else None
+            rows.append((tree_name, (size_text, info, timestamp)))
+
+
+def print_tree(
+    directory,
+    prefix="",
+    stats=None,
+    gitignore=None,
+    show_modified=False,
+    show_tree=True,
+):
+    """Print the directory tree with aligned file metadata."""
+    if stats is None:
+        stats = {"directories": 0, "files": 0, "total_size": 0}
+    rows = []
+    # Walk the filesystem once and collect the output
+    _collect_tree(Path(directory), prefix, stats, gitignore, rows, show_modified)
+    if show_tree:
+        # Align file metadata with the longest tree/name
+        max_tree_name_width = max(
+            (len(tree_name) for tree_name, _ in rows),
+            default=0,
+        )
+        for tree_name, file_info_data in rows:
+            if file_info_data is None:
+                print(tree_name)
+                continue
+            size_text, info, modified = file_info_data
+            output = f"{tree_name:<{max_tree_name_width}}{size_text:>10}    {info:<10}"
+            if modified is not None:
                 output += f"    {modified}"
-            display(output)
+            print(output)
     return stats
 
 
 def parse_args(argv=None):
     """Parse command-line arguments."""
     parser = argparse.ArgumentParser(
-        description="List directory contents in a tree format with file metadata.",
+        description="List directory contents as a tree with file metadata.",
     )
     parser.add_argument(
         "directory",
@@ -228,14 +241,6 @@ def parse_args(argv=None):
         action="store_true",
         help="show summary only",
     )
-    parser.add_argument(
-        "-w",
-        "--width",
-        type=int,
-        default=DEFAULT_METADATA_COLUMN,
-        metavar="N",
-        help=f"starting column for file metadata (default: {DEFAULT_METADATA_COLUMN})",
-    )
     return parser.parse_args(argv)
 
 
@@ -245,9 +250,6 @@ def main():
     if not path.is_dir():
         print(f"Not a directory: {path}")
         return 1
-    if args.width < 1:
-        print("Width must be greater than zero.")
-        return 1
     # Only initialize Git support if it will be used
     gitignore = None if args.all else GitIgnore(path)
     show_tree = not args.summary
@@ -256,7 +258,6 @@ def main():
     stats = print_tree(
         path,
         gitignore=gitignore,
-        width=args.width,
         show_modified=args.modified,
         show_tree=show_tree,
     )
@@ -265,7 +266,7 @@ def main():
     print(
         f"{stats['directories']} directories • "
         f"{stats['files']} files • "
-        f"{format_size(stats['total_size'])}"
+        f"{_format_size(stats['total_size'])}"
     )
     return 0
 

{treex_cli-0.1.1 → treex_cli-0.1.3/treex_cli.egg-info}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: treex-cli
-Version: 0.1.1
-Summary: List directory contents in a tree format with file metadata.
+Version: 0.1.3
+Summary: List directory contents as a tree with file metadata
 Author: Corey Goldberg
 Maintainer: Corey Goldberg
 License-Expression: MIT
@@ -25,7 +25,7 @@ Dynamic: license-file
 
 # treex
 
-## List directory contents in a tree format with file metadata.
+## List directory contents as a tree with file metadata
 
 - Copyright (c) 2026 [Corey Goldberg][github-profile]
 - Development: [GitHub][github-repo]
@@ -36,18 +36,14 @@ Dynamic: license-file
 
 ## About
 
-`treex` is a command-line utility (similar to [tree][tree-home]) that recursively
-scans a directory and prints its contents as a tree using Unicode box-drawing
-characters. File names include their human-readable size and, optionally,
-modification time. Text files also include their line count, while binary and
-unreadable files are marked with their type. When Git is installed, it respects
-`.gitignore` rules.
+`treex` is a command-line utility that recursively scans a directory and
+displays its contents as a tree along with file metadata.
 
-Requirements:
-
-- Python 3.10+
-- Git 2.0+ (optional)
-- UTF-8-compatible terminal
+- File names show human-readable sizes
+- Text files show line counts
+- Binary and unreadable files show their type
+- Modification timestamps are optional
+- Respects `.gitignore` rules when Git is installed
 
 ----
 
@@ -82,6 +78,14 @@ Requirements:
 
 ----
 
+## Requirements
+
+- Python 3.10+
+- Git 2.0+ (optional)
+- UTF-8-compatible terminal
+
+----
+
 ## Installation
 
 Install `treex` from [PyPI][pypi-home] using either `pip` or `pipx`:
@@ -95,9 +99,9 @@ Install `treex` from [PyPI][pypi-home] using either `pip` or `pipx`:
 
 ```
 $ treex --help
-usage: treex [-h] [-a] [-m] [-s] [-w N] [directory]
+usage: treex [-h] [-a] [-m] [-s] [directory]
 
-List directory contents in a tree format with file metadata.
+List directory contents as a tree with file metadata.
 
 positional arguments:
   directory       directory to scan (default: current directory)
@@ -107,7 +111,6 @@ options:
   -a, --all       show all files (including those ignored by Git)
   -m, --modified  show file modification times
   -s, --summary   show summary only
-  -w, --width N   starting column for file metadata (default: 50)
 ```
 
 ----
@@ -120,4 +123,3 @@ options:
 [github-repo]: https://github.com/cgoldberg/treex
 [pypi-home]: https://pypi.org/project/treex-cli
 [mit-license]: https://raw.githubusercontent.com/cgoldberg/treex/refs/heads/main/LICENSE
-[tree-home]: https://oldmanprogrammer.net/source.php?dir=projects/tree