tree-docs 0.1.0__tar.gz

tree_docs-0.1.0/PKG-INFO

@@ -0,0 +1,57 @@
+Metadata-Version: 2.4
+Name: tree-docs
+Version: 0.1.0
+Summary: Gerador automático de árvore de diretórios com emojis e comentários para documentação em Markdown
+Author-email: Kelvin Matheus <kmathews.blaze@email.com>
+License: MIT
+Project-URL: Homepage, https://github.com/seu-usuario/tree-docs
+Project-URL: Documentation, https://tree-docs.readthedocs.io
+Project-URL: Repository, https://github.com/seu-usuario/tree-docs
+Project-URL: Issues, https://github.com/seu-usuario/tree-docs/issues
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Documentation
+Classifier: Topic :: Software Development :: Documentation
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: black>=22.0.0; extra == "dev"
+Requires-Dist: flake8>=5.0.0; extra == "dev"
+Requires-Dist: mypy>=0.990; extra == "dev"
+Requires-Dist: pre-commit>=2.20.0; extra == "dev"
+
+# 🌳 TreeDocs
+
+[![PyPI version](https://badge.fury.io/py/tree-docs.svg)](https://badge.fury.io/py/tree-docs)
+[![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+Gerador automático de árvore de diretórios com emojis e comentários para documentação em Markdown.
+
+## ✨ Features
+
+- 🚀 **Geração automática** da estrutura de diretórios
+- 🎨 **Emojis** para identificar tipos de arquivos
+- 📝 **Comentários** explicativos para pastas e arquivos
+- 🎯 **Alinhamento** profissional dos comentários
+- 🔧 **Altamente configurável**
+- 💻 **CLI** e **API Python** disponíveis
+- 📦 **Zero dependências** externas
+
+## 📦 Instalação
+
+### Via pip (recomendado)
+
+```bash
+pip install tree-docs

tree_docs-0.1.0/README.md

@@ -0,0 +1,25 @@
+# 🌳 TreeDocs
+
+[![PyPI version](https://badge.fury.io/py/tree-docs.svg)](https://badge.fury.io/py/tree-docs)
+[![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+Gerador automático de árvore de diretórios com emojis e comentários para documentação em Markdown.
+
+## ✨ Features
+
+- 🚀 **Geração automática** da estrutura de diretórios
+- 🎨 **Emojis** para identificar tipos de arquivos
+- 📝 **Comentários** explicativos para pastas e arquivos
+- 🎯 **Alinhamento** profissional dos comentários
+- 🔧 **Altamente configurável**
+- 💻 **CLI** e **API Python** disponíveis
+- 📦 **Zero dependências** externas
+
+## 📦 Instalação
+
+### Via pip (recomendado)
+
+```bash
+pip install tree-docs

tree_docs-0.1.0/pyproject.toml

@@ -0,0 +1,85 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "tree-docs"
+version = "0.1.0"
+description = "Gerador automático de árvore de diretórios com emojis e comentários para documentação em Markdown"
+readme = "README.md"
+authors = [
+    {name = "Kelvin Matheus", email = "kmathews.blaze@email.com"}
+]
+license = {text = "MIT"}
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Topic :: Documentation",
+    "Topic :: Software Development :: Documentation",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Operating System :: OS Independent",
+]
+requires-python = ">=3.8"
+dependencies = []
+
+[project.scripts]
+tree-docs = "tree_docs.cli:main"
+
+[project.urls]
+Homepage = "https://github.com/seu-usuario/tree-docs"
+Documentation = "https://tree-docs.readthedocs.io"
+Repository = "https://github.com/seu-usuario/tree-docs"
+Issues = "https://github.com/seu-usuario/tree-docs/issues"
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0.0",
+    "pytest-cov>=4.0.0",
+    "black>=22.0.0",
+    "flake8>=5.0.0",
+    "mypy>=0.990",
+    "pre-commit>=2.20.0",
+]
+
+[tool.black]
+line-length = 100
+target-version = ['py38', 'py39', 'py310', 'py311', 'py312']
+
+[tool.isort]
+profile = "black"
+line_length = 100
+
+[tool.mypy]
+python_version = "3.8"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = "test_*.py"
+python_classes = "Test*"
+python_functions = "test_*"
+addopts = "--cov=tree_docs --cov-report=term-missing --cov-report=html"
+
+[tool.coverage.run]
+source = ["tree_docs"]
+omit = ["tests/*", "examples/*"]
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "def __repr__",
+    "if self.debug:",
+    "if __name__ == .__main__.:",
+    "raise AssertionError",
+    "raise NotImplementedError",
+    "if 0:",
+    "if False:",
+]

tree_docs-0.1.0/setup.cfg

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

tree_docs-0.1.0/tests/test_generator.py

@@ -0,0 +1,76 @@
+"""
+Testes para o TreeDocs
+"""
+
+import os
+import tempfile
+import unittest
+from pathlib import Path
+
+from tree_docs import TreeGenerator, Config
+
+
+class TestTreeGenerator(unittest.TestCase):
+    """Testes para o TreeGenerator"""
+    
+    def setUp(self):
+        """Configura ambiente de teste"""
+        self.temp_dir = tempfile.mkdtemp()
+        self.old_cwd = os.getcwd()
+        os.chdir(self.temp_dir)
+        
+        # Cria estrutura de teste
+        os.makedirs("src/sub")
+        os.makedirs("tests")
+        os.makedirs("docs")
+        
+        with open("src/__init__.py", "w") as f:
+            f.write("# Test")
+        with open("src/main.py", "w") as f:
+            f.write("# Main")
+        with open("README.md", "w") as f:
+            f.write("# README")
+    
+    def tearDown(self):
+        """Limpa ambiente de teste"""
+        os.chdir(self.old_cwd)
+        import shutil
+        shutil.rmtree(self.temp_dir)
+    
+    def test_generator_basic(self):
+        """Testa geração básica"""
+        generator = TreeGenerator()
+        generator.gerar_documentacao(
+            nome_projeto="teste",
+            arquivo_saida="docs/teste.md",
+            root_dir="."
+        )
+        
+        self.assertTrue(os.path.exists("docs/teste.md"))
+        
+        with open("docs/teste.md", "r") as f:
+            content = f.read()
+            self.assertIn("teste/", content)
+            self.assertIn("src", content)
+            self.assertIn("README.md", content)
+    
+    def test_custom_config(self):
+        """Testa configuração personalizada"""
+        config = Config(
+            max_depth=2,
+            ignore_dirs={"tests"}
+        )
+        generator = TreeGenerator(config)
+        generator.gerar_documentacao(
+            nome_projeto="teste",
+            arquivo_saida="docs/teste.md",
+            root_dir="."
+        )
+        
+        with open("docs/teste.md", "r") as f:
+            content = f.read()
+            self.assertNotIn("tests", content)
+
+
+if __name__ == "__main__":
+    unittest.main()

tree_docs-0.1.0/tree_docs/__init__.py

@@ -0,0 +1,19 @@
+"""
+TreeDocs - Gerador automático de árvore de diretórios para documentação em Markdown
+
+Uma ferramenta simples e poderosa para gerar documentação visual da estrutura
+de seus projetos, com emojis, comentários e formatação profissional.
+
+Exemplo de uso:
+    >>> from tree_docs import TreeGenerator
+    >>> generator = TreeGenerator()
+    >>> generator.gerar_documentacao("Meu Projeto", "docs/estrutura.md")
+"""
+
+from .generator import TreeGenerator
+from .config import Config
+from .defaults import DEFAULTS
+from .cli import main
+
+__version__ = "0.1.0"
+__all__ = ["TreeGenerator", "Config", "DEFAULTS", "main"]

tree_docs-0.1.0/tree_docs/cli.py

@@ -0,0 +1,100 @@
+#!/usr/bin/env python
+"""
+Interface de linha de comando para o TreeDocs
+"""
+
+import argparse
+import sys
+from pathlib import Path
+
+from .generator import TreeGenerator
+from .config import Config
+
+
+def main() -> int:
+    """Ponto de entrada principal da CLI"""
+    
+    parser = argparse.ArgumentParser(
+        prog="tree-docs",
+        description="Gerador de árvore de diretórios para documentação em Markdown",
+        epilog="Exemplo: tree-docs -d . -o docs/estrutura.md -n 'Meu Projeto'"
+    )
+    
+    parser.add_argument(
+        "-d", "--directory",
+        default=".",
+        help="Diretório raiz para escanear (padrão: .)"
+    )
+    
+    parser.add_argument(
+        "-o", "--output",
+        default="docs/estrutura_projeto.md",
+        help="Arquivo de saída (padrão: docs/estrutura_projeto.md)"
+    )
+    
+    parser.add_argument(
+        "-n", "--name",
+        default=None,
+        help="Nome do projeto (padrão: nome do diretório)"
+    )
+    
+    parser.add_argument(
+        "--max-depth",
+        type=int,
+        default=5,
+        help="Profundidade máxima da árvore (padrão: 5)"
+    )
+    
+    parser.add_argument(
+        "--ignore",
+        default="venv,__pycache__,.git,.pytest_cache,migrations,node_modules,.idea,.vscode,logs,media,static,__pycache__,dist,build,*.egg-info",
+        help="Pastas a ignorar (separadas por vírgula)"
+    )
+    
+    parser.add_argument(
+        "--no-emojis",
+        action="store_true",
+        help="Desativa emojis na saída (útil para terminais sem suporte)"
+    )
+    
+    parser.add_argument(
+        "-v", "--version",
+        action="version",
+        version=f"tree-docs {__import__('tree_docs').__version__}"
+    )
+    
+    args = parser.parse_args()
+    
+    # Define o nome do projeto
+    project_name = args.name or Path(args.directory).name
+    
+    # Configura pastas a ignorar
+    ignore_dirs = set(args.ignore.split(','))
+    
+    # Cria configuração
+    config = Config(
+        ignore_dirs=ignore_dirs,
+        max_depth=args.max_depth,
+        project_name=project_name,
+        output_file=args.output
+    )
+    
+    # Gera a documentação
+    try:
+        generator = TreeGenerator(config)
+        generator.gerar_documentacao(
+            nome_projeto=project_name,
+            arquivo_saida=args.output,
+            root_dir=args.directory
+        )
+        return 0
+    except KeyboardInterrupt:
+        print("\n⚠️  Operação cancelada pelo usuário")
+        return 1
+    except Exception as e:
+        print(f"❌ Erro: {e}", file=sys.stderr)
+        return 1
+
+
+if __name__ == "__main__":
+    sys.exit(main())

tree_docs-0.1.0/tree_docs/config.py

@@ -0,0 +1,58 @@
+"""
+Configuração personalizada para o TreeDocs
+"""
+
+from typing import Dict, Set, Optional
+from dataclasses import dataclass, field
+
+@dataclass
+class Config:
+    """Configuração do TreeDocs"""
+    
+    # Pastas a ignorar
+    ignore_dirs: Set[str] = field(default_factory=set)
+    
+    # Emojis personalizados
+    emojis: Dict[str, str] = field(default_factory=dict)
+    
+    # Comentários personalizados para pastas
+    pasta_comentarios: Dict[str, str] = field(default_factory=dict)
+    
+    # Comentários personalizados para arquivos
+    arquivo_comentarios: Dict[str, str] = field(default_factory=dict)
+    
+    # Profundidade máxima
+    max_depth: int = 5
+    
+    # Projeto
+    project_name: str = "projeto"
+    
+    # Arquivo de saída
+    output_file: str = "docs/estrutura_projeto.md"
+    
+    def merge_with_defaults(self, defaults):
+        """Mescla configurações com os padrões"""
+        
+        # Mescla ignore_dirs
+        if not self.ignore_dirs:
+            self.ignore_dirs = defaults.IGNORE_DIRS.copy()
+        else:
+            self.ignore_dirs = defaults.IGNORE_DIRS | self.ignore_dirs
+        
+        # Mescla emojis
+        if not self.emojis:
+            self.emojis = defaults.EMOJIS.copy()
+        else:
+            self.emojis = {**defaults.EMOJIS, **self.emojis}
+        
+        # Mescla pasta_comentarios
+        if not self.pasta_comentarios:
+            self.pasta_comentarios = defaults.PASTA_COMENTARIOS.copy()
+        else:
+            self.pasta_comentarios = {**defaults.PASTA_COMENTARIOS, **self.pasta_comentarios}
+        
+        # Mescla arquivo_comentarios
+        if not self.arquivo_comentarios:
+            self.arquivo_comentarios = defaults.ARQUIVO_COMENTARIOS.copy()
+        else:
+            self.arquivo_comentarios = {**defaults.ARQUIVO_COMENTARIOS, **self.arquivo_comentarios}

tree_docs-0.1.0/tree_docs/defaults.py

@@ -0,0 +1,159 @@
+"""
+Configurações padrão do TreeDocs
+"""
+
+from typing import Dict, Set
+
+class DEFAULTS:
+    """Configurações padrão para o gerador"""
+    
+    # Pastas a ignorar automaticamente
+    IGNORE_DIRS: Set[str] = {
+        "venv", "__pycache__", ".git", ".pytest_cache",
+        "migrations", "node_modules", ".idea", ".vscode",
+        "logs", "media", "static", "docs", "__pycache__",
+        "dist", "build", "*.egg-info", ".tox", ".mypy_cache",
+        ".coverage", "htmlcov", ".pytest_cache"
+    }
+    
+    # Emojis por extensão de arquivo
+    EMOJIS: Dict[str, str] = {
+        '.py': '🐍 ',
+        '.md': '📝 ',
+        '.yml': '⚙️ ',
+        '.yaml': '⚙️ ',
+        '.sh': '</> ',
+        '.json': '📊 ',
+        '.txt': '📄 ',
+        '.env': '🌿 ',
+        '.envrc': '🌿 ',
+        '.gitignore': '♦️ ',
+        '.dockerfile': '🐳 ',
+        '.Dockerfile': '🐳 ',
+        '.toml': '📦 ',
+        '.lock': '🔒',
+        '.js': '📜 ',
+        '.ts': '📘 ',
+        '.jsx': '⚛️ ',
+        '.tsx': '⚛️ ',
+        '.css': '🎨 ',
+        '.html': '🌐 ',
+        '.xml': '📋 ',
+        '.sql': '🗄️ ',
+        '.go': '🐹 ',
+        '.rs': '🦀 ',
+        '.java': '☕ ',
+        '.cpp': '⚡ ',
+        '.c': '⚡ ',
+        '.h': '🔧 ',
+    }
+    
+    # Comentários padrão para pastas comuns
+    PASTA_COMENTARIOS: Dict[str, str] = {
+        "backend": "Configurações principais do Backend",
+        "frontend": "Configurações principais do Frontend",
+        "core": "Núcleo da aplicação - Funcionalidades compartilhadas",
+        "api": "Endpoints da API REST",
+        "services": "Lógica de negócio e serviços",
+        "tests": "Testes unitários e de integração",
+        "migrations": "Migrações do banco de dados",
+        "models": "Modelos de dados",
+        "serializers": "Serializers para API",
+        "views": "Views e controladores",
+        "utils": "Funções utilitárias",
+        "templates": "Templates HTML",
+        "static": "Arquivos estáticos (CSS, JS, imagens)",
+        "media": "Arquivos de mídia (uploads)",
+        "config": "Arquivos de configuração",
+        "scripts": "Scripts auxiliares",
+        "docker": "Configurações Docker",
+        "kubernetes": "Manifestos Kubernetes",
+        "helm": "Charts Helm",
+        "terraform": "Configurações Terraform",
+        "ansible": "Playbooks Ansible",
+        "github": "Configurações GitHub",
+        "gitlab": "Configurações GitLab",
+        "vscode": "Configurações VS Code",
+        "idea": "Configurações IntelliJ/PyCharm",
+    }
+    
+    # Comentários padrão para arquivos comuns
+    ARQUIVO_COMENTARIOS: Dict[str, str] = {
+        # Python/Django
+        "settings.py": "Configurações do projeto",
+        "urls.py": "Rotas da aplicação",
+        "wsgi.py": "Configuração WSGI para deploy",
+        "asgi.py": "Configuração ASGI para deploy",
+        "models.py": "Modelos do banco de dados",
+        "serializers.py": "Serializers para API REST",
+        "views.py": "Views/ViewSets da API",
+        "admin.py": "Configuração do Django Admin",
+        "apps.py": "Configuração do app Django",
+        "manage.py": "Script de gerenciamento do Django",
+        
+        # Documentação
+        "README.md": "Documentação principal do projeto",
+        "LICENSE": "Licença do projeto",
+        "CHANGELOG.md": "Histórico de versões",
+        "CONTRIBUTING.md": "Guia de contribuição",
+        "CODE_OF_CONDUCT.md": "Código de conduta",
+        "SECURITY.md": "Política de segurança",
+        
+        # Configuração Python
+        "pyproject.toml": "Configuração do projeto e dependências",
+        "setup.py": "Script de instalação do pacote",
+        "requirements.txt": "Dependências do projeto",
+        "requirements-dev.txt": "Dependências de desenvolvimento",
+        ".flake8": "Configuração do Flake8",
+        ".isort.cfg": "Configuração do isort",
+        ".black": "Configuração do Black",
+        "mypy.ini": "Configuração do Mypy",
+        "pytest.ini": "Configuração do Pytest",
+        
+        # Ambiente
+        ".env": "Variáveis de ambiente",
+        ".env.example": "Exemplo de variáveis de ambiente",
+        ".envrc": "Configuração do direnv",
+        ".gitignore": "Arquivos ignorados no Git",
+        ".dockerignore": "Arquivos ignorados no Docker",
+        
+        # CI/CD
+        ".gitlab-ci.yml": "Pipeline CI/CD do GitLab",
+        ".github/workflows/": "Workflows GitHub Actions",
+        ".travis.yml": "Configuração Travis CI",
+        "Jenkinsfile": "Pipeline Jenkins",
+        
+        # Docker
+        "Dockerfile": "Imagem Docker para desenvolvimento",
+        "Dockerfile.prod": "Imagem Docker para produção",
+        "docker-compose.yml": "Orquestração de containers Docker",
+        
+        # Kubernetes
+        "deployment.yaml": "Deployment Kubernetes",
+        "service.yaml": "Service Kubernetes",
+        "ingress.yaml": "Ingress Kubernetes",
+        "configmap.yaml": "ConfigMap Kubernetes",
+        "secret.yaml": "Secret Kubernetes",
+        "hpa.yaml": "Horizontal Pod Autoscaler",
+        
+        # Frontend
+        "package.json": "Dependências Node.js",
+        "package-lock.json": "Lock de dependências Node",
+        "yarn.lock": "Lock de dependências Yarn",
+        "webpack.config.js": "Configuração Webpack",
+        "vite.config.js": "Configuração Vite",
+        "tsconfig.json": "Configuração TypeScript",
+        
+        # Scripts
+        "entrypoint.sh": "Script de entrada do container",
+        "entrypoint.prod.sh": "Script de entrada (produção)",
+        "start.sh": "Script de inicialização",
+        "build.sh": "Script de build",
+        "deploy.sh": "Script de deploy",
+        
+        # Outros
+        "Makefile": "Comandos automatizados",
+        "gunicorn_conf.py": "Configuração do Gunicorn",
+        "celery.py": "Configuração do Celery",
+        "tasks.py": "Tarefas assíncronas",
+    }

tree_docs-0.1.0/tree_docs/generator.py

@@ -0,0 +1,258 @@
+"""
+Núcleo do gerador de árvore de diretórios
+"""
+
+import os
+import datetime
+from typing import Optional, Set, Dict, List, Tuple
+from pathlib import Path
+
+from .defaults import DEFAULTS
+from .config import Config
+
+
+class TreeGenerator:
+    """
+    Gerador de árvore de diretórios com emojis e comentários
+    
+    Exemplo:
+        >>> generator = TreeGenerator()
+        >>> generator.gerar_documentacao(
+        ...     nome_projeto="meu-projeto",
+        ...     arquivo_saida="docs/estrutura.md"
+        ... )
+    """
+    
+    def __init__(self, config: Optional[Config] = None):
+        """
+        Inicializa o gerador
+        
+        Args:
+            config: Configuração personalizada (opcional)
+        """
+        self.config = config or Config()
+        self.config.merge_with_defaults(DEFAULTS)
+        
+        self.root_dir = "."
+        self.max_depth = self.config.max_depth
+        
+        # Atalhos para as configurações
+        self.ignore_dirs = self.config.ignore_dirs
+        self.emojis = self.config.emojis
+        self.pasta_comentarios = self.config.pasta_comentarios
+        self.arquivo_comentarios = self.config.arquivo_comentarios
+    
+    def gerar_comentario(self, diretorio_pai: str, item: str, is_dir: bool) -> Optional[str]:
+        """
+        Gera comentário explicativo para um item
+        
+        Args:
+            diretorio_pai: Diretório pai do item
+            item: Nome do item
+            is_dir: True se for diretório
+            
+        Returns:
+            Comentário ou None se não houver
+        """
+        if is_dir:
+            # Verifica se o item está nos comentários de pasta
+            if item in self.pasta_comentarios:
+                return self.pasta_comentarios[item]
+            
+            # Comentário genérico para pastas de API
+            if 'api' in diretorio_pai or diretorio_pai.endswith('/api'):
+                nome_limpo = item.replace('_', ' ').title()
+                return f"API de {nome_limpo}"
+            
+            return None
+        
+        # Arquivo
+        if item in self.arquivo_comentarios:
+            return self.arquivo_comentarios[item]
+        
+        # Padrões para arquivos Python
+        if item.endswith('.py'):
+            nome = item[:-3]
+            if 'test' in nome.lower():
+                return "Testes unitários"
+            if 'serializer' in nome.lower():
+                return "Serializers para API"
+            if 'view' in nome.lower():
+                return "Views da API"
+            if 'model' in nome.lower():
+                return "Modelos de dados"
+            if 'admin' in nome.lower():
+                return "Configuração do Admin"
+            if 'urls' in nome.lower():
+                return "Rotas da aplicação"
+            if 'utils' in nome.lower():
+                return "Funções utilitárias"
+        
+        return None
+    
+    def gerar_arvore(
+        self,
+        diretorio: str = ".",
+        prefixo: str = "",
+        nivel: int = 0
+    ) -> str:
+        """
+        Gera a árvore de diretórios recursivamente
+        
+        Args:
+            diretorio: Diretório atual
+            prefixo: Prefixo para formatação da árvore
+            nivel: Nível atual de profundidade
+            
+        Returns:
+            String com a árvore formatada
+        """
+        if nivel > self.max_depth:
+            return ""
+        
+        resultado: List[str] = []
+        
+        try:
+            itens = [i for i in os.listdir(diretorio) if not i.startswith('.')]
+        except PermissionError:
+            return ""
+        
+        # Filtra itens ignorados
+        itens = [i for i in itens if i not in self.ignore_dirs]
+        
+        # Se não há itens, retorna indicador de pasta vazia
+        if not itens:
+            if diretorio != ".":
+                return f"{prefixo}    └── ..."
+            return ""
+        
+        # Separa pastas e arquivos
+        pastas: List[str] = []
+        arquivos: List[str] = []
+        
+        for item in itens:
+            caminho = os.path.join(diretorio, item)
+            if os.path.isdir(caminho):
+                pastas.append(item)
+            else:
+                arquivos.append(item)
+        
+        # Ordena e junta (pastas primeiro)
+        pastas.sort()
+        arquivos.sort()
+        itens_ordenados = pastas + arquivos
+        
+        # Coleta dados de cada item
+        itens_com_dados: List[Tuple[str, bool, Optional[str], str]] = []
+        for item in itens_ordenados:
+            caminho = os.path.join(diretorio, item)
+            is_dir = os.path.isdir(caminho)
+            comentario = self.gerar_comentario(diretorio, item, is_dir)
+            itens_com_dados.append((item, is_dir, comentario, caminho))
+        
+        # Calcula o tamanho máximo para alinhamento
+        max_len = 0
+        for item, is_dir, _, _ in itens_com_dados:
+            linha = f"{prefixo}{'├── '}{'📁 ' if is_dir else '🐍 '}{item}"
+            max_len = max(max_len, len(linha))
+        
+        # Gera a saída
+        for i, (item, is_dir, comentario, caminho) in enumerate(itens_com_dados):
+            is_ultimo = (i == len(itens_com_dados) - 1)
+            
+            # Define caracteres da árvore
+            if is_ultimo:
+                conector = "└── "
+                prefixo_filho = prefixo + "    "
+            else:
+                conector = "├── "
+                prefixo_filho = prefixo + "│   "
+            
+            # Emoji apropriado
+            if is_dir:
+                emoji = "📁 "
+            else:
+                ext = os.path.splitext(item)[1].lower()
+                emoji = self.emojis.get(ext, '📄 ')
+            
+            # Monta a linha
+            linha_base = f"{prefixo}{conector}{emoji}{item}"
+            
+            # Adiciona comentário alinhado à direita
+            if comentario:
+                espacos = max_len - len(linha_base) + 2
+                if espacos < 2:
+                    espacos = 2
+                resultado.append(f"{linha_base}{' ' * espacos}# {comentario}")
+            else:
+                resultado.append(linha_base)
+            
+            # Processa subdiretórios
+            if is_dir:
+                sub = self.gerar_arvore(caminho, prefixo_filho, nivel + 1)
+                if sub:
+                    resultado.append(sub)
+        
+        return "\n".join(resultado)
+    
+    def gerar_documentacao(
+        self,
+        nome_projeto: str = "projeto",
+        arquivo_saida: str = "docs/estrutura_projeto.md",
+        root_dir: str = "."
+    ) -> None:
+        """
+        Gera a documentação completa em Markdown
+        
+        Args:
+            nome_projeto: Nome do projeto
+            arquivo_saida: Caminho do arquivo de saída
+            root_dir: Diretório raiz do projeto
+        """
+        self.root_dir = root_dir
+        
+        # Cria diretório de saída se não existir
+        os.makedirs(os.path.dirname(arquivo_saida) or ".", exist_ok=True)
+        
+        # Gera a árvore
+        arvore = self.gerar_arvore(root_dir)
+        
+        # Prepara o conteúdo
+        conteudo: List[str] = []
+        conteudo.append(f"# 🌳 Estrutura do Projeto - {nome_projeto}\n")
+        conteudo.append(f"\n*Gerado em: {datetime.datetime.now().strftime('%d/%m/%Y %H:%M:%S')}*\n")
+        conteudo.append("\n```bash\n")
+        conteudo.append(f"{nome_projeto}/\n")
+        conteudo.append(arvore)
+        conteudo.append("\n```\n")
+        
+        # Legenda
+        conteudo.append("\n## 📖 Legenda\n\n")
+        conteudo.append("| Emoji | Significado |\n")
+        conteudo.append("|-------|-------------|\n")
+        legendas = [
+            ("📁", "Pasta/Diretório"),
+            ("🐍", "Arquivo Python"),
+            ("📝", "Documentação (MD)"),
+            ("⚙️", "Configuração (YAML)"),
+            ("</>", "Script Shell"),
+            ("📊", "Dados (JSON)"),
+            ("📄", "Arquivo texto"),
+            ("🌿", "Variáveis de ambiente"),
+            ("♦️", "Git"),
+            ("🐳", "Docker"),
+            ("📦", "Pacote Python"),
+            ("🔒", "Arquivo de lock"),
+        ]
+        for emoji, desc in legendas:
+            conteudo.append(f"| {emoji} | {desc} |\n")
+        
+        conteudo.append("\n> **Nota:** Pastas marcadas com `...` estão vazias ou contêm apenas arquivos ignorados.\n")
+        
+        # Escreve o arquivo
+        with open(arquivo_saida, "w", encoding="utf-8") as f:
+            f.write("".join(conteudo))
+            f.flush()
+            os.fsync(f.fileno())
+        
+        print(f"✅ Documentação gerada com sucesso: {arquivo_saida}")

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

@@ -0,0 +1,57 @@
+Metadata-Version: 2.4
+Name: tree-docs
+Version: 0.1.0
+Summary: Gerador automático de árvore de diretórios com emojis e comentários para documentação em Markdown
+Author-email: Kelvin Matheus <kmathews.blaze@email.com>
+License: MIT
+Project-URL: Homepage, https://github.com/seu-usuario/tree-docs
+Project-URL: Documentation, https://tree-docs.readthedocs.io
+Project-URL: Repository, https://github.com/seu-usuario/tree-docs
+Project-URL: Issues, https://github.com/seu-usuario/tree-docs/issues
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Documentation
+Classifier: Topic :: Software Development :: Documentation
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: black>=22.0.0; extra == "dev"
+Requires-Dist: flake8>=5.0.0; extra == "dev"
+Requires-Dist: mypy>=0.990; extra == "dev"
+Requires-Dist: pre-commit>=2.20.0; extra == "dev"
+
+# 🌳 TreeDocs
+
+[![PyPI version](https://badge.fury.io/py/tree-docs.svg)](https://badge.fury.io/py/tree-docs)
+[![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+Gerador automático de árvore de diretórios com emojis e comentários para documentação em Markdown.
+
+## ✨ Features
+
+- 🚀 **Geração automática** da estrutura de diretórios
+- 🎨 **Emojis** para identificar tipos de arquivos
+- 📝 **Comentários** explicativos para pastas e arquivos
+- 🎯 **Alinhamento** profissional dos comentários
+- 🔧 **Altamente configurável**
+- 💻 **CLI** e **API Python** disponíveis
+- 📦 **Zero dependências** externas
+
+## 📦 Instalação
+
+### Via pip (recomendado)
+
+```bash
+pip install tree-docs

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

@@ -0,0 +1,14 @@
+README.md
+pyproject.toml
+tests/test_generator.py
+tree_docs/__init__.py
+tree_docs/cli.py
+tree_docs/config.py
+tree_docs/defaults.py
+tree_docs/generator.py
+tree_docs.egg-info/PKG-INFO
+tree_docs.egg-info/SOURCES.txt
+tree_docs.egg-info/dependency_links.txt
+tree_docs.egg-info/entry_points.txt
+tree_docs.egg-info/requires.txt
+tree_docs.egg-info/top_level.txt

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

@@ -0,0 +1 @@
+

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

@@ -0,0 +1,2 @@
+[console_scripts]
+tree-docs = tree_docs.cli:main

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

@@ -0,0 +1,8 @@
+
+[dev]
+pytest>=7.0.0
+pytest-cov>=4.0.0
+black>=22.0.0
+flake8>=5.0.0
+mypy>=0.990
+pre-commit>=2.20.0

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

@@ -0,0 +1 @@
+tree_docs