abitree 0.1.0__tar.gz

abitree-0.1.0/PKG-INFO

@@ -0,0 +1,87 @@
+Metadata-Version: 2.4
+Name: abitree
+Version: 0.1.0
+Summary: Generate beautiful file trees for your README
+Author: Abidit Shrestha
+License: MIT
+Keywords: cli,tree,readme,file-tree,developer-tools
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Environment :: Console
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+
+# 🌳 abitree
+
+Generate beautiful, icon-rich file trees for your README — instantly.
+
+```
+📁 my-project/
+├── 📁 src/
+│   ├── 🐍 main.py
+│   ├── ⚛️  App.tsx
+│   └── 🎨 styles.css
+├── 📦 package.json
+├── 🐳 Dockerfile
+└── 📝 README.md
+```
+
+## Installation
+
+```bash
+pip install abitree
+```
+
+## Usage
+
+```bash
+# Current directory
+abitree
+
+# Specific path
+abitree ./my-project
+
+# Limit depth
+abitree -L 2
+
+# Output to file
+abitree -o structure.md
+
+# Wrap in markdown code block
+abitree --md
+
+# Directories only
+abitree --dirs-only
+
+# Ignore extra folders
+abitree -i dist,build,.cache
+
+# No icons (plain text)
+abitree --no-icons
+```
+
+## Options
+
+| Flag | Description |
+|------|-------------|
+| `path` | Directory to scan (default: `.`) |
+| `-L, --level` | Max depth |
+| `-o, --output` | Write output to file |
+| `-i, --ignore` | Comma-separated ignore list |
+| `--dirs-only` | Show directories only |
+| `--no-icons` | Disable icons |
+| `--no-default-ignore` | Don't ignore `.git`, `node_modules`, etc. |
+| `--md` | Wrap output in markdown code block |
+
+## Default ignored
+
+`.git`, `__pycache__`, `.DS_Store`, `.idea`, `.vscode`, `node_modules`
+
+## Author
+
+Built by [Abidit Shrestha](https://github.com/abiditshrestha)
+
+## License
+
+MIT

abitree-0.1.0/README.md

@@ -0,0 +1,73 @@
+# 🌳 abitree
+
+Generate beautiful, icon-rich file trees for your README — instantly.
+
+```
+📁 my-project/
+├── 📁 src/
+│   ├── 🐍 main.py
+│   ├── ⚛️  App.tsx
+│   └── 🎨 styles.css
+├── 📦 package.json
+├── 🐳 Dockerfile
+└── 📝 README.md
+```
+
+## Installation
+
+```bash
+pip install abitree
+```
+
+## Usage
+
+```bash
+# Current directory
+abitree
+
+# Specific path
+abitree ./my-project
+
+# Limit depth
+abitree -L 2
+
+# Output to file
+abitree -o structure.md
+
+# Wrap in markdown code block
+abitree --md
+
+# Directories only
+abitree --dirs-only
+
+# Ignore extra folders
+abitree -i dist,build,.cache
+
+# No icons (plain text)
+abitree --no-icons
+```
+
+## Options
+
+| Flag | Description |
+|------|-------------|
+| `path` | Directory to scan (default: `.`) |
+| `-L, --level` | Max depth |
+| `-o, --output` | Write output to file |
+| `-i, --ignore` | Comma-separated ignore list |
+| `--dirs-only` | Show directories only |
+| `--no-icons` | Disable icons |
+| `--no-default-ignore` | Don't ignore `.git`, `node_modules`, etc. |
+| `--md` | Wrap output in markdown code block |
+
+## Default ignored
+
+`.git`, `__pycache__`, `.DS_Store`, `.idea`, `.vscode`, `node_modules`
+
+## Author
+
+Built by [Abidit Shrestha](https://github.com/abiditshrestha)
+
+## License
+
+MIT

abitree-0.1.0/abitree/__init__.py

@@ -0,0 +1 @@
+__version__ = '0.1.0'

abitree-0.1.0/abitree/cli.py

@@ -0,0 +1,98 @@
+import argparse
+import sys
+from .tree import generate_tree
+
+DEFAULT_IGNORE = [".git", "__pycache__", ".DS_Store", ".idea", ".vscode", "node_modules"]
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        prog="abitree",
+        description="🌳 abitree — generate beautiful file trees for your README",
+    )
+
+    parser.add_argument(
+        "path",
+        nargs="?",
+        default=".",
+        help="Path to directory (default: current directory)",
+    )
+
+    parser.add_argument(
+        "-L", "--level",
+        type=int,
+        default=None,
+        metavar="DEPTH",
+        help="Max depth of the tree",
+    )
+
+    parser.add_argument(
+        "-o", "--output",
+        type=str,
+        default=None,
+        metavar="FILE",
+        help="Output to a file (e.g. README.md)",
+    )
+
+    parser.add_argument(
+        "-i", "--ignore",
+        type=str,
+        default=None,
+        metavar="PATTERNS",
+        help="Comma-separated list of names to ignore (e.g. node_modules,.git)",
+    )
+
+    parser.add_argument(
+        "--dirs-only",
+        action="store_true",
+        help="Show directories only",
+    )
+
+    parser.add_argument(
+        "--no-icons",
+        action="store_true",
+        help="Disable icons (plain text output)",
+    )
+
+    parser.add_argument(
+        "--no-default-ignore",
+        action="store_true",
+        help="Disable default ignored folders (.git, node_modules, etc.)",
+    )
+
+    parser.add_argument(
+        "--md",
+        action="store_true",
+        help="Wrap output in a markdown code block",
+    )
+
+    args = parser.parse_args()
+
+    # Build ignore list
+    ignore = [] if args.no_default_ignore else list(DEFAULT_IGNORE)
+    if args.ignore:
+        ignore += [i.strip() for i in args.ignore.split(",")]
+
+    tree = generate_tree(
+        path=args.path,
+        max_depth=args.level,
+        ignore=ignore,
+        dirs_only=args.dirs_only,
+        use_icons=not args.no_icons,
+    )
+
+    if args.md:
+        output = f"```\n{tree}\n```"
+    else:
+        output = tree
+
+    if args.output:
+        with open(args.output, "w") as f:
+            f.write(output + "\n")
+        print(f"✅ Tree written to {args.output}")
+    else:
+        print(output)
+
+
+if __name__ == "__main__":
+    main()

abitree-0.1.0/abitree/icons.py

@@ -0,0 +1,272 @@
+ICONS = {
+    # Folders
+    "__folder__": "📁",
+
+    # Python
+    ".py": "🐍",
+    ".pyw": "🐍",
+    ".ipynb": "📓",
+    ".pyi": "🐍",
+    ".pyc": "🐍",
+
+    # JavaScript / TypeScript
+    ".js": "🟨",
+    ".mjs": "🟨",
+    ".cjs": "🟨",
+    ".ts": "🔷",
+    ".mts": "🔷",
+    ".cts": "🔷",
+    ".jsx": "⚛️",
+    ".tsx": "⚛️",
+
+    # Web
+    ".html": "🌐",
+    ".htm": "🌐",
+    ".css": "🎨",
+    ".scss": "🎨",
+    ".sass": "🎨",
+    ".less": "🎨",
+    ".styl": "🎨",
+
+    # Frameworks / Components
+    ".vue": "💚",
+    ".svelte": "🔥",
+    ".astro": "🚀",
+
+    # Rust
+    ".rs": "🦀",
+    ".toml": "⚙️",
+
+    # Go
+    ".go": "🐹",
+
+    # C / C++
+    ".c": "🔵",
+    ".h": "🔵",
+    ".cpp": "🔵",
+    ".cc": "🔵",
+    ".cxx": "🔵",
+    ".hpp": "🔵",
+    ".hxx": "🔵",
+
+    # Java / JVM
+    ".java": "☕",
+    ".class": "☕",
+    ".jar": "☕",
+    ".kt": "🟣",
+    ".kts": "🟣",
+    ".scala": "🔴",
+    ".groovy": "🟢",
+    ".gradle": "🟢",
+
+    # C# / .NET
+    ".cs": "🟦",
+    ".csx": "🟦",
+    ".vb": "🟦",
+    ".fs": "🟦",
+    ".fsx": "🟦",
+
+    # Ruby
+    ".rb": "💎",
+    ".erb": "💎",
+    ".gemspec": "💎",
+
+    # PHP
+    ".php": "🐘",
+    ".phtml": "🐘",
+
+    # Swift
+    ".swift": "🍎",
+
+    # Dart / Flutter
+    ".dart": "🎯",
+
+    # Lua
+    ".lua": "🌙",
+
+    # Shell / Bash
+    ".sh": "🐚",
+    ".bash": "🐚",
+    ".zsh": "🐚",
+    ".fish": "🐚",
+    ".ps1": "🪟",
+    ".psm1": "🪟",
+    ".bat": "🪟",
+    ".cmd": "🪟",
+
+    # R
+    ".r": "📊",
+    ".R": "📊",
+    ".rmd": "📊",
+    ".Rmd": "📊",
+
+    # Julia
+    ".jl": "🔵",
+
+    # Elixir / Erlang
+    ".ex": "💜",
+    ".exs": "💜",
+    ".erl": "💜",
+    ".hrl": "💜",
+
+    # Haskell
+    ".hs": "🟣",
+    ".lhs": "🟣",
+
+    # Clojure
+    ".clj": "🟢",
+    ".cljs": "🟢",
+    ".cljc": "🟢",
+
+    # Nim
+    ".nim": "🟡",
+
+    # Zig
+    ".zig": "🟠",
+
+    # Config / Infra
+    ".json": "📦",
+    ".jsonc": "📦",
+    ".json5": "📦",
+    ".yaml": "🔧",
+    ".yml": "🔧",
+    ".xml": "📄",
+    ".toml": "⚙️",
+    ".ini": "⚙️",
+    ".cfg": "⚙️",
+    ".conf": "⚙️",
+    ".config": "⚙️",
+    ".env": "🔒",
+    ".env.local": "🔒",
+    ".env.example": "🔒",
+
+    # Docker
+    "Dockerfile": "🐳",
+    ".dockerignore": "🐳",
+    "docker-compose.yml": "🐳",
+    "docker-compose.yaml": "🐳",
+
+    # Kubernetes
+    "k8s": "☸️",
+
+    # CI/CD
+    ".github": "🐙",
+    ".gitlab-ci.yml": "🦊",
+    "Jenkinsfile": "🔵",
+    ".circleci": "⭕",
+    ".travis.yml": "🔨",
+
+    # Package managers
+    "package.json": "📦",
+    "package-lock.json": "🔒",
+    "yarn.lock": "🔒",
+    "pnpm-lock.yaml": "🔒",
+    "Cargo.toml": "⚙️",
+    "Cargo.lock": "🔒",
+    "go.mod": "🐹",
+    "go.sum": "🔒",
+    "Gemfile": "💎",
+    "Gemfile.lock": "🔒",
+    "requirements.txt": "🐍",
+    "pyproject.toml": "🐍",
+    "setup.py": "🐍",
+    "setup.cfg": "🐍",
+    "Pipfile": "🐍",
+    "Pipfile.lock": "🔒",
+    "poetry.lock": "🔒",
+    "composer.json": "🐘",
+    "composer.lock": "🔒",
+    "pubspec.yaml": "🎯",
+    "pubspec.lock": "🔒",
+
+    # Docs
+    ".md": "📝",
+    ".mdx": "📝",
+    ".rst": "📝",
+    ".txt": "📄",
+    ".pdf": "📕",
+    ".doc": "📘",
+    ".docx": "📘",
+
+    # Data
+    ".csv": "📊",
+    ".tsv": "📊",
+    ".sql": "🗄️",
+    ".db": "🗄️",
+    ".sqlite": "🗄️",
+    ".sqlite3": "🗄️",
+    ".graphql": "🔺",
+    ".gql": "🔺",
+    ".proto": "📡",
+
+    # Media
+    ".png": "🖼️",
+    ".jpg": "🖼️",
+    ".jpeg": "🖼️",
+    ".gif": "🖼️",
+    ".svg": "🎨",
+    ".ico": "🖼️",
+    ".webp": "🖼️",
+    ".mp4": "🎥",
+    ".mp3": "🎵",
+    ".wav": "🎵",
+    ".woff": "🔤",
+    ".woff2": "🔤",
+    ".ttf": "🔤",
+    ".otf": "🔤",
+
+    # Git
+    ".gitignore": "🙈",
+    ".gitattributes": "🙈",
+    ".gitmodules": "🙈",
+
+    # Editor configs
+    ".editorconfig": "✏️",
+    ".eslintrc": "🔍",
+    ".eslintignore": "🔍",
+    ".prettierrc": "💅",
+    ".prettierignore": "💅",
+    ".stylelintrc": "💅",
+    ".babelrc": "🔄",
+    "babel.config.js": "🔄",
+    "webpack.config.js": "📦",
+    "vite.config.js": "⚡",
+    "vite.config.ts": "⚡",
+    "tailwind.config.js": "🌊",
+    "tailwind.config.ts": "🌊",
+    "tsconfig.json": "🔷",
+    "jsconfig.json": "🟨",
+
+    # Makefile / Build
+    "Makefile": "🔨",
+    "makefile": "🔨",
+    "CMakeLists.txt": "🔨",
+    "Taskfile.yml": "🔨",
+
+    # Notebooks / misc
+    ".ipynb": "📓",
+    ".http": "🌐",
+    ".rest": "🌐",
+    ".log": "📋",
+    ".lock": "🔒",
+    ".zip": "🗜️",
+    ".tar": "🗜️",
+    ".gz": "🗜️",
+    ".rar": "🗜️",
+
+    # Default
+    "__default__": "📄",
+}
+
+
+def get_icon(name: str, is_dir: bool = False) -> str:
+    if is_dir:
+        return ICONS["__folder__"]
+
+    # Check full filename first (e.g. Dockerfile, Makefile)
+    if name in ICONS:
+        return ICONS[name]
+
+    # Check extension
+    ext = "." + name.rsplit(".", 1)[-1] if "." in name else ""
+    return ICONS.get(ext, ICONS["__default__"])

abitree-0.1.0/abitree/tree.py

@@ -0,0 +1,82 @@
+import os
+from .icons import get_icon
+
+
+def build_tree(
+    root: str,
+    prefix: str = "",
+    max_depth: int = None,
+    current_depth: int = 0,
+    ignore: list = None,
+    dirs_only: bool = False,
+    use_icons: bool = True,
+) -> list:
+    if ignore is None:
+        ignore = []
+
+    if max_depth is not None and current_depth >= max_depth:
+        return []
+
+    try:
+        entries = sorted(os.scandir(root), key=lambda e: (not e.is_dir(), e.name.lower()))
+    except (PermissionError, OSError):
+        return []
+
+    # Skip symlinks that point to directories to avoid infinite loops
+    entries = [e for e in entries if not (e.is_symlink() and e.is_dir())]
+
+    # Filter ignored
+    entries = [e for e in entries if e.name not in ignore]
+
+    # Filter files if dirs only
+    if dirs_only:
+        entries = [e for e in entries if e.is_dir()]
+
+    lines = []
+    for i, entry in enumerate(entries):
+        is_last = i == len(entries) - 1
+        connector = "└── " if is_last else "├── "
+        extension = "    " if is_last else "│   "
+
+        icon = get_icon(entry.name, entry.is_dir()) + " " if use_icons else ""
+        trail = "/" if entry.is_dir() else ""
+
+        lines.append(f"{prefix}{connector}{icon}{entry.name}{trail}")
+
+        if entry.is_dir():
+            lines.extend(
+                build_tree(
+                    root=entry.path,
+                    prefix=prefix + extension,
+                    max_depth=max_depth,
+                    current_depth=current_depth + 1,
+                    ignore=ignore,
+                    dirs_only=dirs_only,
+                    use_icons=use_icons,
+                )
+            )
+
+    return lines
+
+
+def generate_tree(
+    path: str = ".",
+    max_depth: int = None,
+    ignore: list = None,
+    dirs_only: bool = False,
+    use_icons: bool = True,
+) -> str:
+    path = os.path.abspath(path)
+    root_name = os.path.basename(path)
+    icon = get_icon(root_name, is_dir=True) + " " if use_icons else ""
+
+    lines = [f"{icon}{root_name}/"]
+    lines += build_tree(
+        root=path,
+        max_depth=max_depth,
+        ignore=ignore or [],
+        dirs_only=dirs_only,
+        use_icons=use_icons,
+    )
+
+    return "\n".join(lines)

abitree-0.1.0/abitree.egg-info/PKG-INFO

@@ -0,0 +1,87 @@
+Metadata-Version: 2.4
+Name: abitree
+Version: 0.1.0
+Summary: Generate beautiful file trees for your README
+Author: Abidit Shrestha
+License: MIT
+Keywords: cli,tree,readme,file-tree,developer-tools
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Environment :: Console
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+
+# 🌳 abitree
+
+Generate beautiful, icon-rich file trees for your README — instantly.
+
+```
+📁 my-project/
+├── 📁 src/
+│   ├── 🐍 main.py
+│   ├── ⚛️  App.tsx
+│   └── 🎨 styles.css
+├── 📦 package.json
+├── 🐳 Dockerfile
+└── 📝 README.md
+```
+
+## Installation
+
+```bash
+pip install abitree
+```
+
+## Usage
+
+```bash
+# Current directory
+abitree
+
+# Specific path
+abitree ./my-project
+
+# Limit depth
+abitree -L 2
+
+# Output to file
+abitree -o structure.md
+
+# Wrap in markdown code block
+abitree --md
+
+# Directories only
+abitree --dirs-only
+
+# Ignore extra folders
+abitree -i dist,build,.cache
+
+# No icons (plain text)
+abitree --no-icons
+```
+
+## Options
+
+| Flag | Description |
+|------|-------------|
+| `path` | Directory to scan (default: `.`) |
+| `-L, --level` | Max depth |
+| `-o, --output` | Write output to file |
+| `-i, --ignore` | Comma-separated ignore list |
+| `--dirs-only` | Show directories only |
+| `--no-icons` | Disable icons |
+| `--no-default-ignore` | Don't ignore `.git`, `node_modules`, etc. |
+| `--md` | Wrap output in markdown code block |
+
+## Default ignored
+
+`.git`, `__pycache__`, `.DS_Store`, `.idea`, `.vscode`, `node_modules`
+
+## Author
+
+Built by [Abidit Shrestha](https://github.com/abiditshrestha)
+
+## License
+
+MIT

abitree-0.1.0/abitree.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+README.md
+pyproject.toml
+abitree/__init__.py
+abitree/cli.py
+abitree/icons.py
+abitree/tree.py
+abitree.egg-info/PKG-INFO
+abitree.egg-info/SOURCES.txt
+abitree.egg-info/dependency_links.txt
+abitree.egg-info/entry_points.txt
+abitree.egg-info/top_level.txt

abitree-0.1.0/abitree.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

abitree-0.1.0/abitree.egg-info/entry_points.txt

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

abitree-0.1.0/abitree.egg-info/top_level.txt

@@ -0,0 +1 @@
+abitree

abitree-0.1.0/pyproject.toml

@@ -0,0 +1,26 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "abitree"
+version = "0.1.0"
+description = "Generate beautiful file trees for your README"
+authors = [{ name = "Abidit Shrestha" }]
+readme = "README.md"
+license = { text = "MIT" }
+requires-python = ">=3.9"
+keywords = ["cli", "tree", "readme", "file-tree", "developer-tools"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Environment :: Console",
+]
+
+[project.scripts]
+abitree = "abitree.cli:main"
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["abitree*"]

abitree-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+