Readocs

🚀 Gerador inteligente de documentação usando IA para qualquer projeto

📋 Introdução

O Readocs é uma ferramenta universal que utiliza inteligência artificial para analisar automaticamente qualquer projeto de código e gerar documentação personalizada e precisa em PT-BR. Ele funciona com projetos Python, Node.js, React, Java, .NET, Go, Rust e muitos outros.

✨ Principais Características

• 🤖 Análise Inteligente: Detecta automaticamente o tipo de projeto e suas dependências
• 📝 Documentação Personalizada: Gera README.md e CHANGELOG.md baseados no código real
• 🌍 Universal: Funciona com qualquer linguagem de programação
• 🔧 Flexível: CLI simples com opções configuráveis
• 🎯 Preciso: Zero conteúdo genérico - apenas informações reais do projeto

🛠️ Tipos de Projeto Suportados

O Readocs detecta automaticamente e adapta a documentação para:

• Python: Detecta setup.py, pyproject.toml, requirements.txt
• Node.js: Analisa package.json, dependências npm
• React/Next.js: Identifica frameworks JavaScript
• Java: Processa arquivos .java e pom.xml
• C#/.NET: Analisa arquivos .cs e .csproj
• Go: Detecta go.mod e arquivos .go
• Rust: Processa Cargo.toml
• Docker: Identifica Dockerfile e docker-compose.yml

🚀 Instalação

Pré-requisitos

• Python 3.8 ou superior
• Chave API do Anthropic (Claude)

Para Usuários (Instalação Simples) 👤

# Instale diretamente do GitHub
pip install git+https://github.com/julsales/Readocs.git

# Configure interativamente
python -m readocs setup

Para Desenvolvedores (Setup Completo) 🎯

# Clone o repositório
git clone https://github.com/julsales/Readocs.git
cd Readocs

# Execute o setup automático com detecção de ambiente virtual (venv)
python -m readocs dev-setup

Instalação Manual

# Clone o repositório
git clone https://github.com/julsales/Readocs.git
cd Readocs

# Crie e ative um ambiente virtual
python -m venv .venv

# Windows
.venv\Scripts\activate

# Linux/Mac
source .venv/bin/activate

# Instale em modo desenvolvimento
pip install -e .

Após isso, crie um arquivo .env:

ANTHROPIC_API_KEY=sua_chave_api_aqui
READOCS_MODEL_ID=claude-3-haiku-20240307
READOCS_DRY_RUN=0
READOCS_SKIP_CLEAN=0
READOCS_SKIP_CHANGELOG=0

📖 Como Usar

Comandos disponíveis

# Configuração
python -m readocs setup        # Configuração inicial (API key)
python -m readocs dev-setup    # Setup completo para desenvolvedores

# Geração de documentação
python -m readocs generate [projeto] [opções]

# Utilitários
python -m readocs env          # Informações do ambiente
python -m readocs models       # Lista modelos Claude disponíveis
python -m readocs version      # Versão instalada
python -m readocs --help       # Ajuda

Opções do generate

• --output, -o: Diretório de saída
• --model: Modelo Claude (haiku | sonnet)
• --dry-run: Modo teste (não modifica arquivos)
• --skip-clean: Não limpa duplicatas
• --skip-changelog: Não atualiza CHANGELOG

Exemplos de uso

# Primeiro uso
python -m readocs setup
python -m readocs generate

# Casos básicos
python -m readocs generate                              # Projeto atual
python -m readocs generate ./meu-projeto               # Projeto específico
python -m readocs generate ./projeto --output ./docs   # Saída personalizada

# Diferentes tipos de projeto
python -m readocs generate ./projeto-python
python -m readocs generate ./app-react
python -m readocs generate ./api-java

# Com opções
python -m readocs generate --dry-run                    # Teste sem modificar
python -m readocs generate --model claude-3-5-sonnet   # Modelo mais potente
python -m readocs generate --skip-changelog             # Sem CHANGELOG

# Múltiplos projetos
for projeto in app1 app2 api; do
    python -m readocs generate ./$projeto
done

📁 Estrutura do Projeto

readocs/
├── readocs/
│   ├── __init__.py          # Módulo principal
│   ├── cli.py              # Interface de linha de comando
│   ├── main.py             # Lógica principal
│   ├── ui.py               # Interface de usuário
│   ├── agents/             # Agentes de IA
│   │   ├── doc_agent.py    # Agente de documentação
│   │   └── curation_agent.py # Agente de curadoria
│   └── modules/            # Módulos auxiliares
│       ├── readme_utils.py
│       ├── changelog_utils.py
│       ├── file_utils.py
│       └── readme_cleaner.py
├── examples/               # Exemplos de uso
├── requirements.txt        # Dependências Python
└── README.md              # Este arquivo

🤝 Como Contribuir

1. Fork o projeto
2. Crie uma branch para sua feature (git checkout -b feature/nova-feature)
3. Commit suas mudanças (git commit -am 'Adiciona nova feature')
4. Push para a branch (git push origin feature/nova-feature)
5. Abra um Pull Request

📜 Licença

Este projeto está licenciado sob a MIT License.

🆘 Suporte

• Issues: Reporte bugs e solicite features no [GitHub Issues]
• Discussões: Participe das discussões no [GitHub Discussions]

---

Desenvolvido com ❤️ usando IA para tornar a documentação de código mais inteligente