projecttree-by-almira 0.1.0__tar.gz

projecttree_by_almira-0.1.0/PKG-INFO

@@ -0,0 +1,14 @@
+Metadata-Version: 2.4
+Name: projecttree-by-almira
+Version: 0.1.0
+Summary: A beautiful CLI tool to generate project tree structures.
+Author: Almira
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: pyperclip>=1.8.2
+
+# ProjectTree

projecttree_by_almira-0.1.0/README.md

@@ -0,0 +1 @@
+# ProjectTree

projecttree_by_almira-0.1.0/projecttree/__init__.py

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

projecttree_by_almira-0.1.0/projecttree/cli.py

@@ -0,0 +1,85 @@
+import argparse
+import os
+import sys
+from projecttree.scanner import TreeScanner
+from projecttree.formatter import TreeFormatter
+from projecttree.utils import save_to_file, copy_to_clipboard
+
+
+def parse_arguments():
+    parser = argparse.ArgumentParser(
+        description="projecttree — утилита для красивого вывода структуры проекта."
+    )
+    parser.add_argument(
+        "path",
+        nargs="?",
+        default=".",
+        help="Путь к сканируемой директории (по умолчанию: текущая)."
+    )
+    parser.add_argument(
+        "-d", "--depth",
+        type=int,
+        default=None,
+        help="Максимальная глубина отображения дерева."
+    )
+    parser.add_argument(
+        "-i", "--ignore",
+        nargs="+",
+        default=[],
+        help="Список имен файлов/папок для игнорирования."
+    )
+    parser.add_argument(
+        "--dirs-only",
+        action="store_true",
+        help="Отображать только директории."
+    )
+    parser.add_argument(
+        "-o", "--output",
+        type=str,
+        default=None,
+        help="Экспортировать результат в указанный текстовый файл."
+    )
+    parser.add_argument(
+        "-m", "--markdown",
+        action="store_true",
+        help="Вывести структуру в формате Markdown."
+    )
+    parser.add_argument(
+        "-c", "--copy",
+        action="store_true",
+        help="Скопировать результат в буфер обмена."
+    )
+    return parser.parse_args()
+
+
+def main():
+    args = parse_arguments()
+
+    if not os.path.exists(args.path):
+        print(f"Указанный путь не существует: {args.path}", file=sys.stderr)
+        sys.exit(1)
+
+    scanner = TreeScanner(
+        ignore_patterns=args.ignore,
+        dirs_only=args.dirs_only,
+        max_depth=args.depth
+    )
+    tree_model = scanner.scan(args.path)
+
+    if args.markdown:
+        result_text = TreeFormatter.to_markdown(tree_model)
+    else:
+        result_text = TreeFormatter.to_text(tree_model)
+
+    print(result_text)
+    print("-" * 40)
+
+    if args.output:
+        save_to_file(args.output, result_text)
+
+    if args.copy:
+        copy_to_clipboard(result_text)
+
+
+if __name__ == "__main__":
+    main()

projecttree_by_almira-0.1.0/projecttree/formatter.py

@@ -0,0 +1,35 @@
+from projecttree.models import Node
+
+
+class TreeFormatter:
+    @staticmethod
+    def to_text(node: Node, prefix: str = "") -> str:
+        lines = []
+        if not prefix:
+            lines.append(node.name + "/")
+            prefix = ""
+
+        count = len(node.children)
+        for i, child in enumerate(node.children):
+            is_last = (i == count - 1)
+            connector = "└── " if is_last else "├── "
+
+            suffix = "/" if child.is_dir else ""
+            lines.append(f"{prefix}{connector}{child.name}{suffix}")
+
+            if child.is_dir:
+                extension = "    " if is_last else "│   "
+                lines.append(TreeFormatter.to_text(child, prefix + extension))
+
+        return "\n".join(line for line in lines if line.strip())
+
+    @staticmethod
+    def to_markdown(node: Node, depth: int = 0) -> str:
+        indent = "  " * depth
+        suffix = "/" if node.is_dir else ""
+        lines = [f"{indent}- {node.name}{suffix}"]
+
+        for child in node.children:
+            lines.append(TreeFormatter.to_markdown(child, depth + 1))
+
+        return "\n".join(lines)

projecttree_by_almira-0.1.0/projecttree/models.py

@@ -0,0 +1,9 @@
+from dataclasses import dataclass, field
+from typing import List
+
+@dataclass
+class Node:
+    name: str
+    is_dir: bool
+    path: str
+    children: List['Node'] = field(default_factory=list)

projecttree_by_almira-0.1.0/projecttree/scanner.py

@@ -0,0 +1,48 @@
+import os
+from typing import List, Optional
+from projecttree.models import Node
+
+class TreeScanner:
+    def __init__(
+        self,
+        ignore_patterns: Optional[List[str]] = None,
+        dirs_only: bool = False,
+        max_depth: Optional[int] = None
+    ):
+        self.ignore_patterns = ignore_patterns or []
+        self.dirs_only = dirs_only
+        self.max_depth = max_depth
+
+        self.default_ignore = {'.git', '__pycache__', '.pytest_cache', '.venv', 'venv'}
+
+    def _should_ignore(self, name: str) -> bool:
+        if name in self.default_ignore:
+            return True
+        for pattern in self.ignore_patterns:
+            if pattern in name:
+                return True
+        return False
+
+    def scan(self, path: str, current_depth: int = 1) -> Node:
+        name = os.path.basename(os.path.abspath(path)) or path
+        node = Node(name=name, is_dir=True, path=path)
+
+        if self.max_depth is not None and current_depth > self.max_depth:
+            return node
+
+        try:
+            entries = sorted(os.scandir(path), key=lambda e: (not e.is_dir(), e.name.lower()))
+        except PermissionError:
+            return node
+
+        for entry in entries:
+            if self._should_ignore(entry.name):
+                continue
+
+            if entry.is_dir():
+                child_node = self.scan(entry.path, current_depth + 1)
+                node.children.append(child_node)
+            elif not self.dirs_only:
+                node.children.append(Node(name=entry.name, is_dir=False, path=entry.path))
+
+        return node

projecttree_by_almira-0.1.0/projecttree/utils.py

@@ -0,0 +1,17 @@
+import sys
+import pyperclip
+
+def save_to_file(filepath: str, content: str) -> None:
+    try:
+        with open(filepath, "w", encoding="utf-8") as f:
+            f.write(content)
+        print(f"Структура успешно экспортирована в: {filepath}")
+    except Exception as e:
+        print(f"Ошибка при записи в файл: {e}", file=sys.stderr)
+
+def copy_to_clipboard(content: str) -> None:
+    try:
+        pyperclip.copy(content)
+        print("Структура успешно скопирована в буфер обмена!")
+    except Exception as e:
+        print(f"Не удалось скопировать в буфер обмена: {e}", file=sys.stderr)

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

@@ -0,0 +1,14 @@
+Metadata-Version: 2.4
+Name: projecttree-by-almira
+Version: 0.1.0
+Summary: A beautiful CLI tool to generate project tree structures.
+Author: Almira
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: pyperclip>=1.8.2
+
+# ProjectTree

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

@@ -0,0 +1,14 @@
+README.md
+pyproject.toml
+projecttree/__init__.py
+projecttree/cli.py
+projecttree/formatter.py
+projecttree/models.py
+projecttree/scanner.py
+projecttree/utils.py
+projecttree_by_almira.egg-info/PKG-INFO
+projecttree_by_almira.egg-info/SOURCES.txt
+projecttree_by_almira.egg-info/dependency_links.txt
+projecttree_by_almira.egg-info/entry_points.txt
+projecttree_by_almira.egg-info/requires.txt
+projecttree_by_almira.egg-info/top_level.txt

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

@@ -0,0 +1 @@
+

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

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

projecttree_by_almira-0.1.0/projecttree_by_almira.egg-info/requires.txt

@@ -0,0 +1 @@
+pyperclip>=1.8.2

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

@@ -0,0 +1 @@
+projecttree

projecttree_by_almira-0.1.0/pyproject.toml

@@ -0,0 +1,26 @@
+[build-system]
+requires = ["setuptools>=61.0.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "projecttree-by-almira"
+version = "0.1.0"
+description = "A beautiful CLI tool to generate project tree structures."
+readme = "README.md"
+requires-python = ">=3.11"
+license = { text = "MIT" }
+authors = [
+    { name = "Almira" }
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+
+dependencies = [
+    "pyperclip>=1.8.2",
+]
+
+[project.scripts]
+projecttree = "projecttree.cli:main"

projecttree_by_almira-0.1.0/setup.cfg

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