tree-docs 0.1.0__tar.gz → 0.1.1__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- tree_docs-0.1.1/PKG-INFO +185 -0
- tree_docs-0.1.1/README.md +153 -0
- {tree_docs-0.1.0 → tree_docs-0.1.1}/pyproject.toml +2 -2
- {tree_docs-0.1.0 → tree_docs-0.1.1}/tree_docs/__init__.py +2 -2
- tree_docs-0.1.1/tree_docs.egg-info/PKG-INFO +185 -0
- tree_docs-0.1.0/PKG-INFO +0 -57
- tree_docs-0.1.0/README.md +0 -25
- tree_docs-0.1.0/tree_docs.egg-info/PKG-INFO +0 -57
- {tree_docs-0.1.0 → tree_docs-0.1.1}/setup.cfg +0 -0
- {tree_docs-0.1.0 → tree_docs-0.1.1}/tests/test_generator.py +0 -0
- {tree_docs-0.1.0 → tree_docs-0.1.1}/tree_docs/cli.py +0 -0
- {tree_docs-0.1.0 → tree_docs-0.1.1}/tree_docs/config.py +0 -0
- {tree_docs-0.1.0 → tree_docs-0.1.1}/tree_docs/defaults.py +0 -0
- {tree_docs-0.1.0 → tree_docs-0.1.1}/tree_docs/generator.py +0 -0
- {tree_docs-0.1.0 → tree_docs-0.1.1}/tree_docs.egg-info/SOURCES.txt +0 -0
- {tree_docs-0.1.0 → tree_docs-0.1.1}/tree_docs.egg-info/dependency_links.txt +0 -0
- {tree_docs-0.1.0 → tree_docs-0.1.1}/tree_docs.egg-info/entry_points.txt +0 -0
- {tree_docs-0.1.0 → tree_docs-0.1.1}/tree_docs.egg-info/requires.txt +0 -0
- {tree_docs-0.1.0 → tree_docs-0.1.1}/tree_docs.egg-info/top_level.txt +0 -0
tree_docs-0.1.1/PKG-INFO
ADDED
|
@@ -0,0 +1,185 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: tree-docs
|
|
3
|
+
Version: 0.1.1
|
|
4
|
+
Summary: Gerador automático de árvore de diretórios com emojis e comentários para documentação em Markdown
|
|
5
|
+
Author-email: Kelvin Matheus <kmathews.blaze@email.com>
|
|
6
|
+
License: MIT
|
|
7
|
+
Project-URL: Homepage, https://github.com/seu-usuario/tree-docs
|
|
8
|
+
Project-URL: Documentation, https://tree-docs.readthedocs.io
|
|
9
|
+
Project-URL: Repository, https://github.com/seu-usuario/tree-docs
|
|
10
|
+
Project-URL: Issues, https://github.com/seu-usuario/tree-docs/issues
|
|
11
|
+
Classifier: Development Status :: 4 - Beta
|
|
12
|
+
Classifier: Intended Audience :: Developers
|
|
13
|
+
Classifier: Topic :: Documentation
|
|
14
|
+
Classifier: Topic :: Software Development :: Documentation
|
|
15
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
16
|
+
Classifier: Programming Language :: Python :: 3
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.8
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
19
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
20
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
21
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
22
|
+
Classifier: Operating System :: OS Independent
|
|
23
|
+
Requires-Python: >=3.8
|
|
24
|
+
Description-Content-Type: text/markdown
|
|
25
|
+
Provides-Extra: dev
|
|
26
|
+
Requires-Dist: pytest>=7.0.0; extra == "dev"
|
|
27
|
+
Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
|
|
28
|
+
Requires-Dist: black>=22.0.0; extra == "dev"
|
|
29
|
+
Requires-Dist: flake8>=5.0.0; extra == "dev"
|
|
30
|
+
Requires-Dist: mypy>=0.990; extra == "dev"
|
|
31
|
+
Requires-Dist: pre-commit>=2.20.0; extra == "dev"
|
|
32
|
+
|
|
33
|
+
# 🌳 TreeDocs
|
|
34
|
+
|
|
35
|
+
[](https://badge.fury.io/py/tree-docs)
|
|
36
|
+
[](https://www.python.org/downloads/)
|
|
37
|
+
[](https://opensource.org/licenses/MIT)
|
|
38
|
+
[](https://github.com/psf/black)
|
|
39
|
+
|
|
40
|
+
Gerador automático de árvore de diretórios com emojis e comentários para documentação em Markdown.
|
|
41
|
+
|
|
42
|
+
## ✨ Features
|
|
43
|
+
|
|
44
|
+
- 🚀 **Geração automática** da estrutura de diretórios
|
|
45
|
+
- 🎨 **Emojis** para identificar tipos de arquivos
|
|
46
|
+
- 📝 **Comentários** explicativos para pastas e arquivos
|
|
47
|
+
- 🎯 **Alinhamento** profissional dos comentários
|
|
48
|
+
- 🔧 **Altamente configurável**
|
|
49
|
+
- 💻 **CLI** e **API Python** disponíveis
|
|
50
|
+
- 📦 **Zero dependências** externas
|
|
51
|
+
|
|
52
|
+
## 📦 Instalação
|
|
53
|
+
|
|
54
|
+
### Via pip (recomendado)
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
pip install tree-docs
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
### Via pipx (para CLI)
|
|
61
|
+
|
|
62
|
+
```bash
|
|
63
|
+
pipx install tree-docs
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
### Desenvolvimento
|
|
67
|
+
|
|
68
|
+
```bash
|
|
69
|
+
git clone https://github.com/seu-usuario/tree-docs.git
|
|
70
|
+
cd tree-docs
|
|
71
|
+
pip install -e ".[dev]"
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
## 🚀 Uso Rápido
|
|
75
|
+
|
|
76
|
+
### CLI (Linha de comando)
|
|
77
|
+
|
|
78
|
+
```bash
|
|
79
|
+
# Uso básico
|
|
80
|
+
tree-docs -d . -o docs/estrutura.md -n "Meu Projeto"
|
|
81
|
+
|
|
82
|
+
# Com profundidade limitada
|
|
83
|
+
tree-docs -d . --max-depth 3 -o docs/estrutura.md
|
|
84
|
+
|
|
85
|
+
# Ignorando pastas específicas
|
|
86
|
+
tree-docs -d . --ignore "venv,__pycache__,.git" -o docs/estrutura.md
|
|
87
|
+
|
|
88
|
+
# Ajuda
|
|
89
|
+
tree-docs --help
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
### API Python
|
|
93
|
+
|
|
94
|
+
```python
|
|
95
|
+
from tree_docs import TreeGenerator
|
|
96
|
+
|
|
97
|
+
# Uso básico
|
|
98
|
+
generator = TreeGenerator()
|
|
99
|
+
generator.gerar_documentacao(
|
|
100
|
+
nome_projeto="Meu Projeto",
|
|
101
|
+
arquivo_saida="docs/estrutura.md"
|
|
102
|
+
)
|
|
103
|
+
|
|
104
|
+
# Com configuração personalizada
|
|
105
|
+
from tree_docs import Config
|
|
106
|
+
|
|
107
|
+
config = Config(
|
|
108
|
+
max_depth=3,
|
|
109
|
+
ignore_dirs={"venv", "__pycache__"}
|
|
110
|
+
)
|
|
111
|
+
generator = TreeGenerator(config)
|
|
112
|
+
generator.gerar_documentacao("Meu Projeto", "docs/estrutura.md")
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
## 📝 Exemplo de Saída
|
|
116
|
+
|
|
117
|
+
```bash
|
|
118
|
+
meu-projeto/
|
|
119
|
+
├── 📁 backend # Configurações principais do Django
|
|
120
|
+
│ ├── 🐍 __init__.py
|
|
121
|
+
│ ├── 🐍 asgi.py # Configuração ASGI para deploy
|
|
122
|
+
│ ├── 🐍 settings.py # Configurações do projeto
|
|
123
|
+
│ ├── 🐍 urls.py # Rotas globais
|
|
124
|
+
│ └── 🐍 wsgi.py # Configuração WSGI
|
|
125
|
+
├── 📁 core # App Core - Funcionalidades compartilhadas
|
|
126
|
+
│ ├── 🐍 __init__.py
|
|
127
|
+
│ ├── 🐍 admin.py # Configuração do Admin
|
|
128
|
+
│ ├── 🐍 apps.py # Configuração do app
|
|
129
|
+
│ ├── 🐍 models.py # Modelos de dados
|
|
130
|
+
│ └── 🐍 views.py # Views da API
|
|
131
|
+
└── 📄 README.md # Documentação principal
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
## ⚙️ Configuração Avançada
|
|
135
|
+
|
|
136
|
+
```python
|
|
137
|
+
from tree_docs import TreeGenerator, Config
|
|
138
|
+
|
|
139
|
+
# Configuração personalizada
|
|
140
|
+
config = Config(
|
|
141
|
+
max_depth=5,
|
|
142
|
+
ignore_dirs={"venv", "__pycache__", ".git"},
|
|
143
|
+
project_name="meu-projeto",
|
|
144
|
+
output_file="docs/estrutura.md",
|
|
145
|
+
|
|
146
|
+
# Comentários personalizados
|
|
147
|
+
pasta_comentarios={
|
|
148
|
+
"custom": "Minha pasta personalizada"
|
|
149
|
+
},
|
|
150
|
+
arquivo_comentarios={
|
|
151
|
+
"config.py": "Arquivo de configuração do sistema"
|
|
152
|
+
}
|
|
153
|
+
)
|
|
154
|
+
|
|
155
|
+
generator = TreeGenerator(config)
|
|
156
|
+
generator.gerar_documentacao()
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
## 📚 Documentação
|
|
160
|
+
Documentação completa disponível em: https://tree-docs.readthedocs.io
|
|
161
|
+
|
|
162
|
+
## 🤝 Contribuindo
|
|
163
|
+
|
|
164
|
+
Contribuições são bem-vindas! Por favor, leia o guia de contribuição.
|
|
165
|
+
|
|
166
|
+
1. Fork o projeto
|
|
167
|
+
2. Crie sua branch (`git checkout -b feature/AmazingFeature`)
|
|
168
|
+
3. Commit suas mudanças (`git commit -m 'Add some AmazingFeature'`)
|
|
169
|
+
4. Push para a branch (`git push origin feature/AmazingFeature`)
|
|
170
|
+
5. Abra um Pull Request
|
|
171
|
+
|
|
172
|
+
## 📄 Licença
|
|
173
|
+
Distribuído sob a licença MIT. Veja `LICENSE` para mais informações.
|
|
174
|
+
|
|
175
|
+
## 👤 Autor
|
|
176
|
+
Kelvin Matheus - Fullstack Developer
|
|
177
|
+
|
|
178
|
+
GitHub: [@kmatheus](https://github.com/kmatheus)
|
|
179
|
+
|
|
180
|
+
LinkedIn: [Kelvin Matheus](https://www.linkedin.com/in/kelvin-matheusdev/)
|
|
181
|
+
|
|
182
|
+
## ⭐ Agradecimentos
|
|
183
|
+
|
|
184
|
+
- Todos os contribuidores que ajudaram a melhorar esta ferramenta
|
|
185
|
+
- Comunidade Python por manter a linguagem incrível
|
|
@@ -0,0 +1,153 @@
|
|
|
1
|
+
# 🌳 TreeDocs
|
|
2
|
+
|
|
3
|
+
[](https://badge.fury.io/py/tree-docs)
|
|
4
|
+
[](https://www.python.org/downloads/)
|
|
5
|
+
[](https://opensource.org/licenses/MIT)
|
|
6
|
+
[](https://github.com/psf/black)
|
|
7
|
+
|
|
8
|
+
Gerador automático de árvore de diretórios com emojis e comentários para documentação em Markdown.
|
|
9
|
+
|
|
10
|
+
## ✨ Features
|
|
11
|
+
|
|
12
|
+
- 🚀 **Geração automática** da estrutura de diretórios
|
|
13
|
+
- 🎨 **Emojis** para identificar tipos de arquivos
|
|
14
|
+
- 📝 **Comentários** explicativos para pastas e arquivos
|
|
15
|
+
- 🎯 **Alinhamento** profissional dos comentários
|
|
16
|
+
- 🔧 **Altamente configurável**
|
|
17
|
+
- 💻 **CLI** e **API Python** disponíveis
|
|
18
|
+
- 📦 **Zero dependências** externas
|
|
19
|
+
|
|
20
|
+
## 📦 Instalação
|
|
21
|
+
|
|
22
|
+
### Via pip (recomendado)
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
pip install tree-docs
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
### Via pipx (para CLI)
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
pipx install tree-docs
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
### Desenvolvimento
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
git clone https://github.com/seu-usuario/tree-docs.git
|
|
38
|
+
cd tree-docs
|
|
39
|
+
pip install -e ".[dev]"
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
## 🚀 Uso Rápido
|
|
43
|
+
|
|
44
|
+
### CLI (Linha de comando)
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
# Uso básico
|
|
48
|
+
tree-docs -d . -o docs/estrutura.md -n "Meu Projeto"
|
|
49
|
+
|
|
50
|
+
# Com profundidade limitada
|
|
51
|
+
tree-docs -d . --max-depth 3 -o docs/estrutura.md
|
|
52
|
+
|
|
53
|
+
# Ignorando pastas específicas
|
|
54
|
+
tree-docs -d . --ignore "venv,__pycache__,.git" -o docs/estrutura.md
|
|
55
|
+
|
|
56
|
+
# Ajuda
|
|
57
|
+
tree-docs --help
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
### API Python
|
|
61
|
+
|
|
62
|
+
```python
|
|
63
|
+
from tree_docs import TreeGenerator
|
|
64
|
+
|
|
65
|
+
# Uso básico
|
|
66
|
+
generator = TreeGenerator()
|
|
67
|
+
generator.gerar_documentacao(
|
|
68
|
+
nome_projeto="Meu Projeto",
|
|
69
|
+
arquivo_saida="docs/estrutura.md"
|
|
70
|
+
)
|
|
71
|
+
|
|
72
|
+
# Com configuração personalizada
|
|
73
|
+
from tree_docs import Config
|
|
74
|
+
|
|
75
|
+
config = Config(
|
|
76
|
+
max_depth=3,
|
|
77
|
+
ignore_dirs={"venv", "__pycache__"}
|
|
78
|
+
)
|
|
79
|
+
generator = TreeGenerator(config)
|
|
80
|
+
generator.gerar_documentacao("Meu Projeto", "docs/estrutura.md")
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
## 📝 Exemplo de Saída
|
|
84
|
+
|
|
85
|
+
```bash
|
|
86
|
+
meu-projeto/
|
|
87
|
+
├── 📁 backend # Configurações principais do Django
|
|
88
|
+
│ ├── 🐍 __init__.py
|
|
89
|
+
│ ├── 🐍 asgi.py # Configuração ASGI para deploy
|
|
90
|
+
│ ├── 🐍 settings.py # Configurações do projeto
|
|
91
|
+
│ ├── 🐍 urls.py # Rotas globais
|
|
92
|
+
│ └── 🐍 wsgi.py # Configuração WSGI
|
|
93
|
+
├── 📁 core # App Core - Funcionalidades compartilhadas
|
|
94
|
+
│ ├── 🐍 __init__.py
|
|
95
|
+
│ ├── 🐍 admin.py # Configuração do Admin
|
|
96
|
+
│ ├── 🐍 apps.py # Configuração do app
|
|
97
|
+
│ ├── 🐍 models.py # Modelos de dados
|
|
98
|
+
│ └── 🐍 views.py # Views da API
|
|
99
|
+
└── 📄 README.md # Documentação principal
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
## ⚙️ Configuração Avançada
|
|
103
|
+
|
|
104
|
+
```python
|
|
105
|
+
from tree_docs import TreeGenerator, Config
|
|
106
|
+
|
|
107
|
+
# Configuração personalizada
|
|
108
|
+
config = Config(
|
|
109
|
+
max_depth=5,
|
|
110
|
+
ignore_dirs={"venv", "__pycache__", ".git"},
|
|
111
|
+
project_name="meu-projeto",
|
|
112
|
+
output_file="docs/estrutura.md",
|
|
113
|
+
|
|
114
|
+
# Comentários personalizados
|
|
115
|
+
pasta_comentarios={
|
|
116
|
+
"custom": "Minha pasta personalizada"
|
|
117
|
+
},
|
|
118
|
+
arquivo_comentarios={
|
|
119
|
+
"config.py": "Arquivo de configuração do sistema"
|
|
120
|
+
}
|
|
121
|
+
)
|
|
122
|
+
|
|
123
|
+
generator = TreeGenerator(config)
|
|
124
|
+
generator.gerar_documentacao()
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
## 📚 Documentação
|
|
128
|
+
Documentação completa disponível em: https://tree-docs.readthedocs.io
|
|
129
|
+
|
|
130
|
+
## 🤝 Contribuindo
|
|
131
|
+
|
|
132
|
+
Contribuições são bem-vindas! Por favor, leia o guia de contribuição.
|
|
133
|
+
|
|
134
|
+
1. Fork o projeto
|
|
135
|
+
2. Crie sua branch (`git checkout -b feature/AmazingFeature`)
|
|
136
|
+
3. Commit suas mudanças (`git commit -m 'Add some AmazingFeature'`)
|
|
137
|
+
4. Push para a branch (`git push origin feature/AmazingFeature`)
|
|
138
|
+
5. Abra um Pull Request
|
|
139
|
+
|
|
140
|
+
## 📄 Licença
|
|
141
|
+
Distribuído sob a licença MIT. Veja `LICENSE` para mais informações.
|
|
142
|
+
|
|
143
|
+
## 👤 Autor
|
|
144
|
+
Kelvin Matheus - Fullstack Developer
|
|
145
|
+
|
|
146
|
+
GitHub: [@kmatheus](https://github.com/kmatheus)
|
|
147
|
+
|
|
148
|
+
LinkedIn: [Kelvin Matheus](https://www.linkedin.com/in/kelvin-matheusdev/)
|
|
149
|
+
|
|
150
|
+
## ⭐ Agradecimentos
|
|
151
|
+
|
|
152
|
+
- Todos os contribuidores que ajudaram a melhorar esta ferramenta
|
|
153
|
+
- Comunidade Python por manter a linguagem incrível
|
|
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
|
|
|
4
4
|
|
|
5
5
|
[project]
|
|
6
6
|
name = "tree-docs"
|
|
7
|
-
version = "0.1.
|
|
7
|
+
version = "0.1.1"
|
|
8
8
|
description = "Gerador automático de árvore de diretórios com emojis e comentários para documentação em Markdown"
|
|
9
9
|
readme = "README.md"
|
|
10
10
|
authors = [
|
|
@@ -82,4 +82,4 @@ exclude_lines = [
|
|
|
82
82
|
"raise NotImplementedError",
|
|
83
83
|
"if 0:",
|
|
84
84
|
"if False:",
|
|
85
|
-
]
|
|
85
|
+
]
|
|
@@ -0,0 +1,185 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: tree-docs
|
|
3
|
+
Version: 0.1.1
|
|
4
|
+
Summary: Gerador automático de árvore de diretórios com emojis e comentários para documentação em Markdown
|
|
5
|
+
Author-email: Kelvin Matheus <kmathews.blaze@email.com>
|
|
6
|
+
License: MIT
|
|
7
|
+
Project-URL: Homepage, https://github.com/seu-usuario/tree-docs
|
|
8
|
+
Project-URL: Documentation, https://tree-docs.readthedocs.io
|
|
9
|
+
Project-URL: Repository, https://github.com/seu-usuario/tree-docs
|
|
10
|
+
Project-URL: Issues, https://github.com/seu-usuario/tree-docs/issues
|
|
11
|
+
Classifier: Development Status :: 4 - Beta
|
|
12
|
+
Classifier: Intended Audience :: Developers
|
|
13
|
+
Classifier: Topic :: Documentation
|
|
14
|
+
Classifier: Topic :: Software Development :: Documentation
|
|
15
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
16
|
+
Classifier: Programming Language :: Python :: 3
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.8
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
19
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
20
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
21
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
22
|
+
Classifier: Operating System :: OS Independent
|
|
23
|
+
Requires-Python: >=3.8
|
|
24
|
+
Description-Content-Type: text/markdown
|
|
25
|
+
Provides-Extra: dev
|
|
26
|
+
Requires-Dist: pytest>=7.0.0; extra == "dev"
|
|
27
|
+
Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
|
|
28
|
+
Requires-Dist: black>=22.0.0; extra == "dev"
|
|
29
|
+
Requires-Dist: flake8>=5.0.0; extra == "dev"
|
|
30
|
+
Requires-Dist: mypy>=0.990; extra == "dev"
|
|
31
|
+
Requires-Dist: pre-commit>=2.20.0; extra == "dev"
|
|
32
|
+
|
|
33
|
+
# 🌳 TreeDocs
|
|
34
|
+
|
|
35
|
+
[](https://badge.fury.io/py/tree-docs)
|
|
36
|
+
[](https://www.python.org/downloads/)
|
|
37
|
+
[](https://opensource.org/licenses/MIT)
|
|
38
|
+
[](https://github.com/psf/black)
|
|
39
|
+
|
|
40
|
+
Gerador automático de árvore de diretórios com emojis e comentários para documentação em Markdown.
|
|
41
|
+
|
|
42
|
+
## ✨ Features
|
|
43
|
+
|
|
44
|
+
- 🚀 **Geração automática** da estrutura de diretórios
|
|
45
|
+
- 🎨 **Emojis** para identificar tipos de arquivos
|
|
46
|
+
- 📝 **Comentários** explicativos para pastas e arquivos
|
|
47
|
+
- 🎯 **Alinhamento** profissional dos comentários
|
|
48
|
+
- 🔧 **Altamente configurável**
|
|
49
|
+
- 💻 **CLI** e **API Python** disponíveis
|
|
50
|
+
- 📦 **Zero dependências** externas
|
|
51
|
+
|
|
52
|
+
## 📦 Instalação
|
|
53
|
+
|
|
54
|
+
### Via pip (recomendado)
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
pip install tree-docs
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
### Via pipx (para CLI)
|
|
61
|
+
|
|
62
|
+
```bash
|
|
63
|
+
pipx install tree-docs
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
### Desenvolvimento
|
|
67
|
+
|
|
68
|
+
```bash
|
|
69
|
+
git clone https://github.com/seu-usuario/tree-docs.git
|
|
70
|
+
cd tree-docs
|
|
71
|
+
pip install -e ".[dev]"
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
## 🚀 Uso Rápido
|
|
75
|
+
|
|
76
|
+
### CLI (Linha de comando)
|
|
77
|
+
|
|
78
|
+
```bash
|
|
79
|
+
# Uso básico
|
|
80
|
+
tree-docs -d . -o docs/estrutura.md -n "Meu Projeto"
|
|
81
|
+
|
|
82
|
+
# Com profundidade limitada
|
|
83
|
+
tree-docs -d . --max-depth 3 -o docs/estrutura.md
|
|
84
|
+
|
|
85
|
+
# Ignorando pastas específicas
|
|
86
|
+
tree-docs -d . --ignore "venv,__pycache__,.git" -o docs/estrutura.md
|
|
87
|
+
|
|
88
|
+
# Ajuda
|
|
89
|
+
tree-docs --help
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
### API Python
|
|
93
|
+
|
|
94
|
+
```python
|
|
95
|
+
from tree_docs import TreeGenerator
|
|
96
|
+
|
|
97
|
+
# Uso básico
|
|
98
|
+
generator = TreeGenerator()
|
|
99
|
+
generator.gerar_documentacao(
|
|
100
|
+
nome_projeto="Meu Projeto",
|
|
101
|
+
arquivo_saida="docs/estrutura.md"
|
|
102
|
+
)
|
|
103
|
+
|
|
104
|
+
# Com configuração personalizada
|
|
105
|
+
from tree_docs import Config
|
|
106
|
+
|
|
107
|
+
config = Config(
|
|
108
|
+
max_depth=3,
|
|
109
|
+
ignore_dirs={"venv", "__pycache__"}
|
|
110
|
+
)
|
|
111
|
+
generator = TreeGenerator(config)
|
|
112
|
+
generator.gerar_documentacao("Meu Projeto", "docs/estrutura.md")
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
## 📝 Exemplo de Saída
|
|
116
|
+
|
|
117
|
+
```bash
|
|
118
|
+
meu-projeto/
|
|
119
|
+
├── 📁 backend # Configurações principais do Django
|
|
120
|
+
│ ├── 🐍 __init__.py
|
|
121
|
+
│ ├── 🐍 asgi.py # Configuração ASGI para deploy
|
|
122
|
+
│ ├── 🐍 settings.py # Configurações do projeto
|
|
123
|
+
│ ├── 🐍 urls.py # Rotas globais
|
|
124
|
+
│ └── 🐍 wsgi.py # Configuração WSGI
|
|
125
|
+
├── 📁 core # App Core - Funcionalidades compartilhadas
|
|
126
|
+
│ ├── 🐍 __init__.py
|
|
127
|
+
│ ├── 🐍 admin.py # Configuração do Admin
|
|
128
|
+
│ ├── 🐍 apps.py # Configuração do app
|
|
129
|
+
│ ├── 🐍 models.py # Modelos de dados
|
|
130
|
+
│ └── 🐍 views.py # Views da API
|
|
131
|
+
└── 📄 README.md # Documentação principal
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
## ⚙️ Configuração Avançada
|
|
135
|
+
|
|
136
|
+
```python
|
|
137
|
+
from tree_docs import TreeGenerator, Config
|
|
138
|
+
|
|
139
|
+
# Configuração personalizada
|
|
140
|
+
config = Config(
|
|
141
|
+
max_depth=5,
|
|
142
|
+
ignore_dirs={"venv", "__pycache__", ".git"},
|
|
143
|
+
project_name="meu-projeto",
|
|
144
|
+
output_file="docs/estrutura.md",
|
|
145
|
+
|
|
146
|
+
# Comentários personalizados
|
|
147
|
+
pasta_comentarios={
|
|
148
|
+
"custom": "Minha pasta personalizada"
|
|
149
|
+
},
|
|
150
|
+
arquivo_comentarios={
|
|
151
|
+
"config.py": "Arquivo de configuração do sistema"
|
|
152
|
+
}
|
|
153
|
+
)
|
|
154
|
+
|
|
155
|
+
generator = TreeGenerator(config)
|
|
156
|
+
generator.gerar_documentacao()
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
## 📚 Documentação
|
|
160
|
+
Documentação completa disponível em: https://tree-docs.readthedocs.io
|
|
161
|
+
|
|
162
|
+
## 🤝 Contribuindo
|
|
163
|
+
|
|
164
|
+
Contribuições são bem-vindas! Por favor, leia o guia de contribuição.
|
|
165
|
+
|
|
166
|
+
1. Fork o projeto
|
|
167
|
+
2. Crie sua branch (`git checkout -b feature/AmazingFeature`)
|
|
168
|
+
3. Commit suas mudanças (`git commit -m 'Add some AmazingFeature'`)
|
|
169
|
+
4. Push para a branch (`git push origin feature/AmazingFeature`)
|
|
170
|
+
5. Abra um Pull Request
|
|
171
|
+
|
|
172
|
+
## 📄 Licença
|
|
173
|
+
Distribuído sob a licença MIT. Veja `LICENSE` para mais informações.
|
|
174
|
+
|
|
175
|
+
## 👤 Autor
|
|
176
|
+
Kelvin Matheus - Fullstack Developer
|
|
177
|
+
|
|
178
|
+
GitHub: [@kmatheus](https://github.com/kmatheus)
|
|
179
|
+
|
|
180
|
+
LinkedIn: [Kelvin Matheus](https://www.linkedin.com/in/kelvin-matheusdev/)
|
|
181
|
+
|
|
182
|
+
## ⭐ Agradecimentos
|
|
183
|
+
|
|
184
|
+
- Todos os contribuidores que ajudaram a melhorar esta ferramenta
|
|
185
|
+
- Comunidade Python por manter a linguagem incrível
|
tree_docs-0.1.0/PKG-INFO
DELETED
|
@@ -1,57 +0,0 @@
|
|
|
1
|
-
Metadata-Version: 2.4
|
|
2
|
-
Name: tree-docs
|
|
3
|
-
Version: 0.1.0
|
|
4
|
-
Summary: Gerador automático de árvore de diretórios com emojis e comentários para documentação em Markdown
|
|
5
|
-
Author-email: Kelvin Matheus <kmathews.blaze@email.com>
|
|
6
|
-
License: MIT
|
|
7
|
-
Project-URL: Homepage, https://github.com/seu-usuario/tree-docs
|
|
8
|
-
Project-URL: Documentation, https://tree-docs.readthedocs.io
|
|
9
|
-
Project-URL: Repository, https://github.com/seu-usuario/tree-docs
|
|
10
|
-
Project-URL: Issues, https://github.com/seu-usuario/tree-docs/issues
|
|
11
|
-
Classifier: Development Status :: 4 - Beta
|
|
12
|
-
Classifier: Intended Audience :: Developers
|
|
13
|
-
Classifier: Topic :: Documentation
|
|
14
|
-
Classifier: Topic :: Software Development :: Documentation
|
|
15
|
-
Classifier: License :: OSI Approved :: MIT License
|
|
16
|
-
Classifier: Programming Language :: Python :: 3
|
|
17
|
-
Classifier: Programming Language :: Python :: 3.8
|
|
18
|
-
Classifier: Programming Language :: Python :: 3.9
|
|
19
|
-
Classifier: Programming Language :: Python :: 3.10
|
|
20
|
-
Classifier: Programming Language :: Python :: 3.11
|
|
21
|
-
Classifier: Programming Language :: Python :: 3.12
|
|
22
|
-
Classifier: Operating System :: OS Independent
|
|
23
|
-
Requires-Python: >=3.8
|
|
24
|
-
Description-Content-Type: text/markdown
|
|
25
|
-
Provides-Extra: dev
|
|
26
|
-
Requires-Dist: pytest>=7.0.0; extra == "dev"
|
|
27
|
-
Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
|
|
28
|
-
Requires-Dist: black>=22.0.0; extra == "dev"
|
|
29
|
-
Requires-Dist: flake8>=5.0.0; extra == "dev"
|
|
30
|
-
Requires-Dist: mypy>=0.990; extra == "dev"
|
|
31
|
-
Requires-Dist: pre-commit>=2.20.0; extra == "dev"
|
|
32
|
-
|
|
33
|
-
# 🌳 TreeDocs
|
|
34
|
-
|
|
35
|
-
[](https://badge.fury.io/py/tree-docs)
|
|
36
|
-
[](https://www.python.org/downloads/)
|
|
37
|
-
[](https://opensource.org/licenses/MIT)
|
|
38
|
-
[](https://github.com/psf/black)
|
|
39
|
-
|
|
40
|
-
Gerador automático de árvore de diretórios com emojis e comentários para documentação em Markdown.
|
|
41
|
-
|
|
42
|
-
## ✨ Features
|
|
43
|
-
|
|
44
|
-
- 🚀 **Geração automática** da estrutura de diretórios
|
|
45
|
-
- 🎨 **Emojis** para identificar tipos de arquivos
|
|
46
|
-
- 📝 **Comentários** explicativos para pastas e arquivos
|
|
47
|
-
- 🎯 **Alinhamento** profissional dos comentários
|
|
48
|
-
- 🔧 **Altamente configurável**
|
|
49
|
-
- 💻 **CLI** e **API Python** disponíveis
|
|
50
|
-
- 📦 **Zero dependências** externas
|
|
51
|
-
|
|
52
|
-
## 📦 Instalação
|
|
53
|
-
|
|
54
|
-
### Via pip (recomendado)
|
|
55
|
-
|
|
56
|
-
```bash
|
|
57
|
-
pip install tree-docs
|
tree_docs-0.1.0/README.md
DELETED
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
# 🌳 TreeDocs
|
|
2
|
-
|
|
3
|
-
[](https://badge.fury.io/py/tree-docs)
|
|
4
|
-
[](https://www.python.org/downloads/)
|
|
5
|
-
[](https://opensource.org/licenses/MIT)
|
|
6
|
-
[](https://github.com/psf/black)
|
|
7
|
-
|
|
8
|
-
Gerador automático de árvore de diretórios com emojis e comentários para documentação em Markdown.
|
|
9
|
-
|
|
10
|
-
## ✨ Features
|
|
11
|
-
|
|
12
|
-
- 🚀 **Geração automática** da estrutura de diretórios
|
|
13
|
-
- 🎨 **Emojis** para identificar tipos de arquivos
|
|
14
|
-
- 📝 **Comentários** explicativos para pastas e arquivos
|
|
15
|
-
- 🎯 **Alinhamento** profissional dos comentários
|
|
16
|
-
- 🔧 **Altamente configurável**
|
|
17
|
-
- 💻 **CLI** e **API Python** disponíveis
|
|
18
|
-
- 📦 **Zero dependências** externas
|
|
19
|
-
|
|
20
|
-
## 📦 Instalação
|
|
21
|
-
|
|
22
|
-
### Via pip (recomendado)
|
|
23
|
-
|
|
24
|
-
```bash
|
|
25
|
-
pip install tree-docs
|
|
@@ -1,57 +0,0 @@
|
|
|
1
|
-
Metadata-Version: 2.4
|
|
2
|
-
Name: tree-docs
|
|
3
|
-
Version: 0.1.0
|
|
4
|
-
Summary: Gerador automático de árvore de diretórios com emojis e comentários para documentação em Markdown
|
|
5
|
-
Author-email: Kelvin Matheus <kmathews.blaze@email.com>
|
|
6
|
-
License: MIT
|
|
7
|
-
Project-URL: Homepage, https://github.com/seu-usuario/tree-docs
|
|
8
|
-
Project-URL: Documentation, https://tree-docs.readthedocs.io
|
|
9
|
-
Project-URL: Repository, https://github.com/seu-usuario/tree-docs
|
|
10
|
-
Project-URL: Issues, https://github.com/seu-usuario/tree-docs/issues
|
|
11
|
-
Classifier: Development Status :: 4 - Beta
|
|
12
|
-
Classifier: Intended Audience :: Developers
|
|
13
|
-
Classifier: Topic :: Documentation
|
|
14
|
-
Classifier: Topic :: Software Development :: Documentation
|
|
15
|
-
Classifier: License :: OSI Approved :: MIT License
|
|
16
|
-
Classifier: Programming Language :: Python :: 3
|
|
17
|
-
Classifier: Programming Language :: Python :: 3.8
|
|
18
|
-
Classifier: Programming Language :: Python :: 3.9
|
|
19
|
-
Classifier: Programming Language :: Python :: 3.10
|
|
20
|
-
Classifier: Programming Language :: Python :: 3.11
|
|
21
|
-
Classifier: Programming Language :: Python :: 3.12
|
|
22
|
-
Classifier: Operating System :: OS Independent
|
|
23
|
-
Requires-Python: >=3.8
|
|
24
|
-
Description-Content-Type: text/markdown
|
|
25
|
-
Provides-Extra: dev
|
|
26
|
-
Requires-Dist: pytest>=7.0.0; extra == "dev"
|
|
27
|
-
Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
|
|
28
|
-
Requires-Dist: black>=22.0.0; extra == "dev"
|
|
29
|
-
Requires-Dist: flake8>=5.0.0; extra == "dev"
|
|
30
|
-
Requires-Dist: mypy>=0.990; extra == "dev"
|
|
31
|
-
Requires-Dist: pre-commit>=2.20.0; extra == "dev"
|
|
32
|
-
|
|
33
|
-
# 🌳 TreeDocs
|
|
34
|
-
|
|
35
|
-
[](https://badge.fury.io/py/tree-docs)
|
|
36
|
-
[](https://www.python.org/downloads/)
|
|
37
|
-
[](https://opensource.org/licenses/MIT)
|
|
38
|
-
[](https://github.com/psf/black)
|
|
39
|
-
|
|
40
|
-
Gerador automático de árvore de diretórios com emojis e comentários para documentação em Markdown.
|
|
41
|
-
|
|
42
|
-
## ✨ Features
|
|
43
|
-
|
|
44
|
-
- 🚀 **Geração automática** da estrutura de diretórios
|
|
45
|
-
- 🎨 **Emojis** para identificar tipos de arquivos
|
|
46
|
-
- 📝 **Comentários** explicativos para pastas e arquivos
|
|
47
|
-
- 🎯 **Alinhamento** profissional dos comentários
|
|
48
|
-
- 🔧 **Altamente configurável**
|
|
49
|
-
- 💻 **CLI** e **API Python** disponíveis
|
|
50
|
-
- 📦 **Zero dependências** externas
|
|
51
|
-
|
|
52
|
-
## 📦 Instalação
|
|
53
|
-
|
|
54
|
-
### Via pip (recomendado)
|
|
55
|
-
|
|
56
|
-
```bash
|
|
57
|
-
pip install tree-docs
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|