treex-cli 0.1.0__tar.gz → 0.1.2__tar.gz

{treex_cli-0.1.0/treex_cli.egg-info → treex_cli-0.1.2}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: treex-cli
-Version: 0.1.0
-Summary: Print a directory tree with file metadata
+Version: 0.1.2
+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
 
-## Print a directory tree with file metadata
+## List directory contents as a tree with file metadata
 
 - Copyright (c) 2026 [Corey Goldberg][github-profile]
 - Development: [GitHub][github-repo]
@@ -36,14 +36,49 @@ 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:
+- 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
+
+----
+
+## Status
+
+<table>
+  <tr>
+    <td>Latest Version</td>
+    <td>
+      <a href="https://pypi.org/project/treex-cli">
+        <img src="https://img.shields.io/pypi/v/treex-cli.svg">
+      </a>
+    </td>
+  </tr>
+  <tr>
+    <td>Tests (CI)</td>
+    <td>
+      <a href="https://github.com/cgoldberg/treex/actions/workflows/test.yml">
+        <img src="https://github.com/cgoldberg/treex/actions/workflows/test.yml/badge.svg">
+      </a>
+    </td>
+  </tr>
+  <tr>
+    <td>Supported Python Versions</td>
+    <td>
+      <a href="https://pypi.org/project/treex-cli">
+        <img src="https://img.shields.io/pypi/pyversions/treex-cli">
+      </a>
+    </td>
+  </tr>
+</table>
+
+----
+
+## Requirements
 
 - Python 3.10+
 - Git 2.0+ (optional)
@@ -64,22 +99,27 @@ Install `treex` from [PyPI][pypi-home] using either `pip` or `pipx`:
 
 ```
 $ treex --help
-usage: treex [-h] [-a] [-w N] [-m] [directory]
+usage: treex [-h] [-a] [-m] [-s] [directory]
 
-print a directory tree with file metadata.
+List directory contents as a tree with file metadata.
 
 positional arguments:
   directory       directory to scan (default: current directory)
 
 options:
   -h, --help      show this help message and exit
-  -a, --all       show all files, including git-ignored
-  -w, --width N   starting column for file metadata (default: 50)
+  -a, --all       show all files (including those ignored by Git)
   -m, --modified  show file modification times
+  -s, --summary   show summary only
 ```
 
+----
+
+## Screenshot
+
+![Screenshot](https://raw.githubusercontent.com/cgoldberg/treex/refs/heads/main/screenshot.png)
+
 [github-profile]: https://github.com/cgoldberg
 [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.2/README.md

@@ -0,0 +1,100 @@
+# treex
+
+## List directory contents as a tree with file metadata
+
+- Copyright (c) 2026 [Corey Goldberg][github-profile]
+- Development: [GitHub][github-repo]
+- Releases: [PyPI][pypi-home]
+- License: [MIT][mit-license]
+
+----
+
+## About
+
+`treex` is a command-line utility that recursively scans a directory and
+displays its contents as a tree along with file metadata.
+
+- 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
+
+----
+
+## Status
+
+<table>
+  <tr>
+    <td>Latest Version</td>
+    <td>
+      <a href="https://pypi.org/project/treex-cli">
+        <img src="https://img.shields.io/pypi/v/treex-cli.svg">
+      </a>
+    </td>
+  </tr>
+  <tr>
+    <td>Tests (CI)</td>
+    <td>
+      <a href="https://github.com/cgoldberg/treex/actions/workflows/test.yml">
+        <img src="https://github.com/cgoldberg/treex/actions/workflows/test.yml/badge.svg">
+      </a>
+    </td>
+  </tr>
+  <tr>
+    <td>Supported Python Versions</td>
+    <td>
+      <a href="https://pypi.org/project/treex-cli">
+        <img src="https://img.shields.io/pypi/pyversions/treex-cli">
+      </a>
+    </td>
+  </tr>
+</table>
+
+----
+
+## Requirements
+
+- Python 3.10+
+- Git 2.0+ (optional)
+- UTF-8-compatible terminal
+
+----
+
+## Installation
+
+Install `treex` from [PyPI][pypi-home] using either `pip` or `pipx`:
+
+- `pip install treex-cli`
+- `pipx install treex-cli`
+
+----
+
+## Usage
+
+```
+$ treex --help
+usage: treex [-h] [-a] [-m] [-s] [directory]
+
+List directory contents as a tree with file metadata.
+
+positional arguments:
+  directory       directory to scan (default: current directory)
+
+options:
+  -h, --help      show this help message and exit
+  -a, --all       show all files (including those ignored by Git)
+  -m, --modified  show file modification times
+  -s, --summary   show summary only
+```
+
+----
+
+## Screenshot
+
+![Screenshot](https://raw.githubusercontent.com/cgoldberg/treex/refs/heads/main/screenshot.png)
+
+[github-profile]: https://github.com/cgoldberg
+[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

{treex_cli-0.1.0 → treex_cli-0.1.2}/pyproject.toml

@@ -4,8 +4,8 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "treex-cli"
-version = "0.1.0"
-description = "Print a directory tree with file metadata"
+version = "0.1.2"
+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.0 → treex_cli-0.1.2}/treex.py

@@ -2,21 +2,14 @@
 # SPDX-License-Identifier: MIT
 
 
-"""Print a directory tree 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,17 +18,15 @@ from contextlib import suppress
 from datetime import datetime
 from pathlib import Path
 
-DEFAULT_METADATA_COLUMN = 50
-
 
 class GitIgnore:
-    """Use Git's own ignore machinery when available."""
+    """Use Git's ignore rules when available."""
 
     def __init__(self, directory):
         self.directory = Path(directory).resolve()
         self.enabled = False
         self.repo_root = None
-        # Git isn't installed or can't be executed.
+        # Check Git availability and find the repository root
         with suppress(OSError):
             result = subprocess.run(
                 ["git", "rev-parse", "--show-toplevel"],
@@ -45,12 +36,13 @@ class GitIgnore:
                 text=True,
                 check=False,
             )
+            # Enable Git support if this is a repository
             if result.returncode == 0:
                 self.repo_root = Path(result.stdout.strip()).resolve()
                 self.enabled = True
 
     def ignored(self, path):
-        """Return True if Git considers the path ignored."""
+        """Check if Git considers the path ignored."""
         if not self.enabled:
             return False
         try:
@@ -80,12 +72,12 @@ def format_size(size):  # noqa: RET503
 
 
 def format_modified(timestamp):
-    """Format a modification timestamp for display."""
+    """Format a modification timestamp."""
     return datetime.fromtimestamp(timestamp).strftime("%Y-%m-%d %H:%M")
 
 
 def is_binary_file(path, chunk_size=8192):
-    """Return True if the file appears to be binary."""
+    """Check if the file appears to be binary."""
     try:
         with path.open("rb") as f:
             chunk = f.read(chunk_size)
@@ -107,18 +99,15 @@ def is_binary_file(path, chunk_size=8192):
 
 def count_lines(path):
     """Count lines without loading the entire file into memory."""
-    count = 0
     try:
         with path.open("rb") as f:
-            for _ in f:
-                count += 1
+            return sum(1 for _ in f)
     except OSError:
         return None
-    return count
 
 
 def file_info(path):
-    """Return size, description, raw size, and modification time."""
+    """Get file info."""
     try:
         stat = path.stat()
         size = stat.st_size
@@ -134,61 +123,89 @@ def file_info(path):
     return size_text, f"{lines:,} lines", size, modified
 
 
-def print_tree(
-    directory,
-    prefix="",
-    stats=None,
-    gitignore=None,
-    width=DEFAULT_METADATA_COLUMN,
-    show_modified=False,
-):
-    """Recursively print the directory tree."""
-    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:
-        print(prefix + "└── [permission denied]")
-        return stats
-    # Filter ignored entries before determining which entry is last.
-    visible_entries = []
-    for entry in entries:
-        # Git's internal repository data is never useful in the tree output.
-        if entry.name == ".git":
-            continue
-        if gitignore and gitignore.ignored(entry):
-            continue
-        visible_entries.append(entry)
-    visible_entries.sort(key=lambda p: (p.is_file(), p.name.lower()))
-    for index, entry in enumerate(visible_entries):
-        is_last = index == len(visible_entries) - 1
+        return None
+    # Filter ignored entries and Git's internal directory
+    entries = [
+        entry
+        for entry in entries
+        if not entry.is_symlink()
+        and (not gitignore or (entry.name != ".git" and not gitignore.ignored(entry)))
+    ]
+    # 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
-            print(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,
             )
         elif entry.is_file():
             stats["files"] += 1
-            size, info, raw_size, modified = file_info(entry)
-            stats["total_size"] += raw_size
-            # The complete tree/name portion is padded to the
-            # requested width so metadata lines up vertically.
-            tree_name = prefix + connector + entry.name
-            output = f"{tree_name:<{width}}{size:>10}    {info}"
-            if show_modified and modified is not None:
+            size_text, info, size, modified = file_info(entry)
+            stats["total_size"] += size
+            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}"
             print(output)
     return stats
@@ -197,7 +214,7 @@ def print_tree(
 def parse_args(argv=None):
     """Parse command-line arguments."""
     parser = argparse.ArgumentParser(
-        description="print a directory tree with file metadata.",
+        description="List directory contents as a tree with file metadata.",
     )
     parser.add_argument(
         "directory",
@@ -210,15 +227,7 @@ def parse_args(argv=None):
         "-a",
         "--all",
         action="store_true",
-        help="show all files, including git-ignored",
-    )
-    parser.add_argument(
-        "-w",
-        "--width",
-        type=int,
-        default=DEFAULT_METADATA_COLUMN,
-        metavar="N",
-        help=f"starting column for file metadata (default: {DEFAULT_METADATA_COLUMN})",
+        help="show all files (including those ignored by Git)",
     )
     parser.add_argument(
         "-m",
@@ -226,6 +235,12 @@ def parse_args(argv=None):
         action="store_true",
         help="show file modification times",
     )
+    parser.add_argument(
+        "-s",
+        "--summary",
+        action="store_true",
+        help="show summary only",
+    )
     return parser.parse_args(argv)
 
 
@@ -235,20 +250,22 @@ 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 integration when it will actually be used.
+    # Only initialize Git support if it will be used
     gitignore = None if args.all else GitIgnore(path)
-    print(path.resolve())
+    show_tree = not args.summary
+    if show_tree:
+        print(path)
     stats = print_tree(
-        path, gitignore=gitignore, width=args.width, show_modified=args.modified
+        path,
+        gitignore=gitignore,
+        show_modified=args.modified,
+        show_tree=show_tree,
     )
+    if show_tree:
+        print()
     print(
-        f""
-        f""
-        f"{stats['directories']} directories, "
-        f"{stats['files']} files, "
+        f"{stats['directories']} directories • "
+        f"{stats['files']} files • "
         f"{format_size(stats['total_size'])}"
     )
     return 0

{treex_cli-0.1.0 → treex_cli-0.1.2/treex_cli.egg-info}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: treex-cli
-Version: 0.1.0
-Summary: Print a directory tree with file metadata
+Version: 0.1.2
+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
 
-## Print a directory tree with file metadata
+## List directory contents as a tree with file metadata
 
 - Copyright (c) 2026 [Corey Goldberg][github-profile]
 - Development: [GitHub][github-repo]
@@ -36,14 +36,49 @@ 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:
+- 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
+
+----
+
+## Status
+
+<table>
+  <tr>
+    <td>Latest Version</td>
+    <td>
+      <a href="https://pypi.org/project/treex-cli">
+        <img src="https://img.shields.io/pypi/v/treex-cli.svg">
+      </a>
+    </td>
+  </tr>
+  <tr>
+    <td>Tests (CI)</td>
+    <td>
+      <a href="https://github.com/cgoldberg/treex/actions/workflows/test.yml">
+        <img src="https://github.com/cgoldberg/treex/actions/workflows/test.yml/badge.svg">
+      </a>
+    </td>
+  </tr>
+  <tr>
+    <td>Supported Python Versions</td>
+    <td>
+      <a href="https://pypi.org/project/treex-cli">
+        <img src="https://img.shields.io/pypi/pyversions/treex-cli">
+      </a>
+    </td>
+  </tr>
+</table>
+
+----
+
+## Requirements
 
 - Python 3.10+
 - Git 2.0+ (optional)
@@ -64,22 +99,27 @@ Install `treex` from [PyPI][pypi-home] using either `pip` or `pipx`:
 
 ```
 $ treex --help
-usage: treex [-h] [-a] [-w N] [-m] [directory]
+usage: treex [-h] [-a] [-m] [-s] [directory]
 
-print a directory tree with file metadata.
+List directory contents as a tree with file metadata.
 
 positional arguments:
   directory       directory to scan (default: current directory)
 
 options:
   -h, --help      show this help message and exit
-  -a, --all       show all files, including git-ignored
-  -w, --width N   starting column for file metadata (default: 50)
+  -a, --all       show all files (including those ignored by Git)
   -m, --modified  show file modification times
+  -s, --summary   show summary only
 ```
 
+----
+
+## Screenshot
+
+![Screenshot](https://raw.githubusercontent.com/cgoldberg/treex/refs/heads/main/screenshot.png)
+
 [github-profile]: https://github.com/cgoldberg
 [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.0/README.md

@@ -1,60 +0,0 @@
-# treex
-
-## Print a directory tree with file metadata
-
-- Copyright (c) 2026 [Corey Goldberg][github-profile]
-- Development: [GitHub][github-repo]
-- Releases: [PyPI][pypi-home]
-- License: [MIT][mit-license]
-
-----
-
-## 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.
-
-Requirements:
-
-- Python 3.10+
-- Git 2.0+ (optional)
-- UTF-8-compatible terminal
-
-----
-
-## Installation
-
-Install `treex` from [PyPI][pypi-home] using either `pip` or `pipx`:
-
-- `pip install treex-cli`
-- `pipx install treex-cli`
-
-----
-
-## Usage
-
-```
-$ treex --help
-usage: treex [-h] [-a] [-w N] [-m] [directory]
-
-print a directory tree with file metadata.
-
-positional arguments:
-  directory       directory to scan (default: current directory)
-
-options:
-  -h, --help      show this help message and exit
-  -a, --all       show all files, including git-ignored
-  -w, --width N   starting column for file metadata (default: 50)
-  -m, --modified  show file modification times
-```
-
-[github-profile]: https://github.com/cgoldberg
-[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