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

{treex_cli-0.1.0/treex_cli.egg-info → treex_cli-0.1.1}/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.1
+Summary: List directory contents in a tree format 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 in a tree format with file metadata.
 
 - Copyright (c) 2026 [Corey Goldberg][github-profile]
 - Development: [GitHub][github-repo]
@@ -51,6 +51,37 @@ Requirements:
 
 ----
 
+## 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>
+
+----
+
 ## Installation
 
 Install `treex` from [PyPI][pypi-home] using either `pip` or `pipx`:
@@ -64,20 +95,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] [-w N] [directory]
 
-print a directory tree with file metadata.
+List directory contents in a tree format 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
+  -w, --width N   starting column for file metadata (default: 50)
 ```
 
+----
+
+## 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

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

@@ -1,6 +1,6 @@
 # treex
 
-## Print a directory tree with file metadata
+## List directory contents in a tree format with file metadata.
 
 - Copyright (c) 2026 [Corey Goldberg][github-profile]
 - Development: [GitHub][github-repo]
@@ -26,6 +26,37 @@ Requirements:
 
 ----
 
+## 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>
+
+----
+
 ## Installation
 
 Install `treex` from [PyPI][pypi-home] using either `pip` or `pipx`:
@@ -39,20 +70,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] [-w N] [directory]
 
-print a directory tree with file metadata.
+List directory contents in a tree format 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
+  -w, --width N   starting column for file metadata (default: 50)
 ```
 
+----
+
+## 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

{treex_cli-0.1.0 → treex_cli-0.1.1}/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.1"
+description="List directory contents in a tree format with file metadata."
 license = "MIT"
 license-files = ["LICENSE"]
 authors = [{name = "Corey Goldberg"}]

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

@@ -2,7 +2,7 @@
 # SPDX-License-Identifier: MIT
 
 
-"""Print a directory tree with file metadata.
+"""List directory contents in a tree-like format 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
@@ -29,13 +29,13 @@ 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 +45,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 +81,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 +108,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
@@ -141,8 +139,14 @@ def print_tree(
     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,
@@ -153,24 +157,23 @@ def print_tree(
     try:
         entries = list(path.iterdir())
     except PermissionError:
-        print(prefix + "└── [permission denied]")
+        display(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()))
+    # Filter ignored entries and Git's internal directory
+    visible_entries = [
+        entry
+        for entry in entries
+        if 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
         connector = "└── " if is_last else "├── "
         if entry.is_dir():
             stats["directories"] += 1
-            print(prefix + connector + entry.name)
+            display(f"{prefix}{connector}{entry.name}")
             extension = "    " if is_last else "│   "
             print_tree(
                 entry,
@@ -179,25 +182,26 @@ def print_tree(
                 gitignore,
                 width,
                 show_modified,
+                show_tree,
             )
         elif entry.is_file():
             stats["files"] += 1
-            size, info, raw_size, modified = file_info(entry)
-            stats["total_size"] += raw_size
+            size_text, info, size, modified = file_info(entry)
+            stats["total_size"] += size
             # The complete tree/name portion is padded to the
-            # requested width so metadata lines up vertically.
+            # specified width so metadata lines up vertically.
             tree_name = prefix + connector + entry.name
-            output = f"{tree_name:<{width}}{size:>10}    {info}"
+            output = f"{tree_name:<{width}}{size_text:>10}    {info}"
             if show_modified and modified is not None:
                 output += f"    {modified}"
-            print(output)
+            display(output)
     return stats
 
 
 def parse_args(argv=None):
     """Parse command-line arguments."""
     parser = argparse.ArgumentParser(
-        description="print a directory tree with file metadata.",
+        description="List directory contents in a tree format with file metadata.",
     )
     parser.add_argument(
         "directory",
@@ -210,7 +214,19 @@ def parse_args(argv=None):
         "-a",
         "--all",
         action="store_true",
-        help="show all files, including git-ignored",
+        help="show all files (including those ignored by Git)",
+    )
+    parser.add_argument(
+        "-m",
+        "--modified",
+        action="store_true",
+        help="show file modification times",
+    )
+    parser.add_argument(
+        "-s",
+        "--summary",
+        action="store_true",
+        help="show summary only",
     )
     parser.add_argument(
         "-w",
@@ -220,12 +236,6 @@ def parse_args(argv=None):
         metavar="N",
         help=f"starting column for file metadata (default: {DEFAULT_METADATA_COLUMN})",
     )
-    parser.add_argument(
-        "-m",
-        "--modified",
-        action="store_true",
-        help="show file modification times",
-    )
     return parser.parse_args(argv)
 
 
@@ -238,17 +248,23 @@ def main():
     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,
+        width=args.width,
+        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.1/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.1
+Summary: List directory contents in a tree format 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 in a tree format with file metadata.
 
 - Copyright (c) 2026 [Corey Goldberg][github-profile]
 - Development: [GitHub][github-repo]
@@ -51,6 +51,37 @@ Requirements:
 
 ----
 
+## 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>
+
+----
+
 ## Installation
 
 Install `treex` from [PyPI][pypi-home] using either `pip` or `pipx`:
@@ -64,20 +95,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] [-w N] [directory]
 
-print a directory tree with file metadata.
+List directory contents in a tree format 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
+  -w, --width N   starting column for file metadata (default: 50)
 ```
 
+----
+
+## 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