treecap 0.1.0__py3-none-any.whl

treecap/__init__.py

@@ -0,0 +1,3 @@
+"""treecap — a tree view that caps entries per directory."""
+
+__version__ = "0.1.0"

treecap/cli.py

@@ -0,0 +1,93 @@
+"""treecap CLI — print a directory tree, capping entries shown per folder.
+
+Unlike `tree --filelimit`, which hides a directory entirely once it has too
+many entries, treecap always recurses but caps the *display* per directory,
+collapsing the overflow into a "... (N more)" line.
+"""
+import argparse
+import os
+import sys
+
+from . import __version__
+
+# Directories we never descend into by default.
+DEFAULT_SKIP = {".git", "node_modules", "__pycache__", ".venv", "venv"}
+
+
+def list_entries(path, show_all, skip):
+    try:
+        entries = sorted(
+            os.scandir(path), key=lambda e: (not e.is_dir(), e.name.lower())
+        )
+    except (PermissionError, FileNotFoundError):
+        return []
+    out = []
+    for e in entries:
+        if not show_all and e.name.startswith("."):
+            continue
+        if e.is_dir() and e.name in skip:
+            continue
+        out.append(e)
+    return out
+
+
+def walk(path, prefix, width, max_depth, depth, show_all, skip):
+    if max_depth is not None and depth >= max_depth:
+        return
+    entries = list_entries(path, show_all, skip)
+    shown = entries if width is None else entries[:width]
+    hidden = len(entries) - len(shown)
+
+    for i, e in enumerate(shown):
+        last = (i == len(shown) - 1) and hidden == 0
+        connector = "└── " if last else "├── "
+        print(prefix + connector + e.name + ("/" if e.is_dir() else ""))
+        if e.is_dir():
+            extension = "    " if last else "│   "
+            walk(e.path, prefix + extension, width, max_depth,
+                 depth + 1, show_all, skip)
+
+    if hidden > 0:
+        print(prefix + f"└── ... ({hidden} more)")
+
+
+def build_parser():
+    p = argparse.ArgumentParser(
+        prog="treecap",
+        description="A directory tree that caps how many entries are shown "
+                    "per folder (the rest collapse into '... (N more)').",
+    )
+    p.add_argument("root", nargs="?", default=".",
+                   help="directory to walk (default: current dir)")
+    p.add_argument("-W", "--width", type=int, default=5, metavar="N",
+                   help="max entries shown per directory (default: 5; "
+                        "use 0 for unlimited)")
+    p.add_argument("-L", "--level", type=int, default=None, metavar="DEPTH",
+                   help="max display depth (default: unlimited)")
+    p.add_argument("-a", "--all", action="store_true",
+                   help="include hidden files/dirs (dotfiles)")
+    p.add_argument("--no-skip", action="store_true",
+                   help="don't skip .git/node_modules/__pycache__/.venv")
+    p.add_argument("--version", action="version",
+                   version=f"%(prog)s {__version__}")
+    return p
+
+
+def main(argv=None):
+    args = build_parser().parse_args(argv)
+    width = None if args.width == 0 else args.width
+    skip = set() if args.no_skip else DEFAULT_SKIP
+
+    print(args.root.rstrip("/") + "/")
+    try:
+        walk(args.root, "", width, args.level, 0, args.all, skip)
+    except BrokenPipeError:  # e.g. piped into `head`
+        try:
+            sys.stdout.close()
+        except Exception:
+            pass
+    return 0
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

treecap-0.1.0.dist-info/METADATA

@@ -0,0 +1,54 @@
+Metadata-Version: 2.4
+Name: treecap
+Version: 0.1.0
+Summary: A directory tree that caps how many entries are shown per folder.
+Author: Dheeraj Pai
+License: MIT
+Project-URL: Homepage, https://github.com/dheerajpai/treecap
+Keywords: tree,cli,filesystem,directory
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Environment :: Console
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+
+# treecap
+
+A directory tree that shows the **full structure** but caps how many entries
+are shown per folder. The overflow collapses into a `... (N more)` line — so a
+folder with 698 files doesn't drown the rest of the tree.
+
+Unlike `tree -L` (which limits depth) or `tree --filelimit` (which hides big
+directories entirely), `treecap` always recurses but caps the *display* width
+per directory.
+
+## Install
+
+```bash
+pipx install .        # recommended — isolated, on your PATH
+# or
+pip install -e .      # editable install into the current environment
+```
+
+## Usage
+
+```bash
+treecap                 # current dir, 5 entries per folder
+treecap -W 10           # show 10 entries per folder
+treecap -L 3            # limit display depth to 3 levels
+treecap -W 5 -L 4 data  # 5 per folder, 4 deep, starting at ./data
+treecap -a              # include hidden dotfiles
+treecap --no-skip       # don't auto-skip .git/node_modules/etc.
+treecap > dir.tree      # save to a file
+```
+
+### Options
+
+| Flag | Meaning |
+|------|---------|
+| `-W, --width N` | Max entries shown per directory (default 5; `0` = unlimited) |
+| `-L, --level DEPTH` | Max display depth (default: unlimited) |
+| `-a, --all` | Include hidden files/dirs |
+| `--no-skip` | Don't skip `.git`, `node_modules`, `__pycache__`, `.venv`, `venv` |
+| `--version` | Print version |

treecap-0.1.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+treecap/__init__.py,sha256=HY_NJswjG_fzZnzxJ5OfeZKzfy6Nk6RZ8HT9kILwu2I,86
+treecap/cli.py,sha256=Ufq-q6pUgySG4oTv-2fFsR5SkKF2zh7nRh57CzCMLWc,3219
+treecap-0.1.0.dist-info/METADATA,sha256=75X0JjZrvFA4bFDBIQVtwhBCXMcpHNO5Pse9QcwTRs4,1843
+treecap-0.1.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+treecap-0.1.0.dist-info/entry_points.txt,sha256=RzfPCN9hQjOt6zk5BrPDOKa_MtfRIp_X1cpMOqKLjMQ,45
+treecap-0.1.0.dist-info/top_level.txt,sha256=YLX5s6KQh3XIhQGzi9VNUYLhU5S2DMavZofNH8exGRA,8
+treecap-0.1.0.dist-info/RECORD,,

treecap-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

treecap-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+treecap = treecap.cli:main

treecap-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+treecap