Skip to main content

Uma biblioteca para scraping com lógica fuzzy e conversão de HTML e conteúdos ao seu redor, lidando com reatividade do javascript para Markdown focado em LLMs. Adicionado com um pipeline RAG.

Project description

Pymandua Logo

Pymandua: Web Scraper para todos os websites

Conversão de HTML para Markdown para pré-processamento de LLMs

Este projeto é uma biblioteca Python que realiza Web Scraping inteligente com lógica fuzzy e converte páginas HTML e conteúdos relacionados (como subpáginas e conteúdos renderizados com JS) em um Markdown simplificado, ideal para Large Language Models (LLMs) e análises posteriores.


🚀 Funcionalidades

  • Web scraping automatizado com Selenium e suporte a páginas dinâmicas
  • Conversão precisa de HTML para Markdown limpo com suporte a:
    • Títulos, parágrafos, listas, links, tabelas, blocos de código, entre outros
  • Lógica de busca fuzzy para identificar se o conteúdo da página e páginas ao seu redor está relacionado às palavras-chave desejadas
  • Mecanismo de retorno automático de páginas visitadas
  • Pode ser utilizado como biblioteca ou como script principal

🧠 Como Funciona

🔍 Web Scraping com Selenium

O módulo utiliza o undetected-chromedriver e selenium-stealth com o selenium para navegar por páginas web, extrair conteúdos e retroceder após a coleta. O conteúdo das páginas é tratado pelo BeautifulSoup e convertido em Markdown por um parser customizado.

🧪 Lógica Fuzzy

A comparação entre o conteúdo da página e as palavras-chave fornecidas é feita com RapidFuzz, utilizando similaridade textual (ex: token_sort_ratio). Isso permite validar se a página realmente trata do tema buscado, mesmo que o texto não seja exatamente igual, ou se existe alguns conteúdos ao seu redor (subpáginas e conteúdos criados a partir de reatividade com JavaScript) para capturar e consolidar em um único lugar.


🖼️ Fluxo do Processo

Fluxograma do Processo

🧪 Instalação

Com pip

pip install pymandua

Ou alternativamente

  1. Clone o repositório:
git clone https://github.com/Mark-Campanella/pymandua.git
cd pymandua
  1. Crie um ambiente virtual e ative:
python -m venv env
source env/bin/activate  # Linux/macOS
env\Scripts\activate     # Windows
  1. Instale as dependências:
pip install -r requirements.txt

🔧 Uso como script

from pymandua import to_mkd

result = to_mkd(
    urls="https://pt.wikipedia.org/wiki/Luís_XIV_de_França",
    keywords=["Luís XIV", "França", "Rei Sol"],
    output_path=r"projeto/output",
    wait=2,
    threshold=90
)
print(result)

Uso como CLI

to-mkd --urls "https://exemplo.com" --keywords "palavra1,palavra2" --output "saida.md" --wait 2 --threshold 95

🧩 Estrutura do Projeto

├── pymandua/              # Módulo principal
│   ├── interface.py       # Interface principal do conversor
│   ├── converter.py       # Conversor de HTML para Markdown
│   ├── gatherer.py        # Web scraper e parser de conteúdo
│   ├── driver.py          # Inicializador de driver para o selenium
│   ├── crawler.py         # Web crawler e parser de conteúdo
│   ├── treater.py         # Prepara para o cleaner
│   ├── aggregator.py      # Agrega os diversos HTMLs resultantes em um para ser convertido
│   ├── cleaner.py         # Parser e limpador de conteúdo não necessário
├── output/                # Arquivos .mkd gerados
├── requirements.txt       # Dependências
├── main.py                # Exemplo de uso

📚 Referências


🧠 RAG Pipeline (Análise com IA)

Este projeto estende sua funcionalidade principal com um pipeline de Análise de Conteúdo usando Retrieval-Augmented Generation (RAG). Ele permite que você use os arquivos Markdown gerados para consultas inteligentes, respondendo perguntas e gerando tabelas estruturadas sobre o conteúdo.

🚀 Funcionalidades Chave do RAG

  • Modularidade "Plug & Play": Alterne facilmente entre diferentes provedores de LLM (Ollama, OpenAI, Gemini) e bancos de dados vetoriais (ChromaDB, Pinecone) com a simples alteração de um parâmetro.

  • Interface Web (UI): Uma interface interativa e amigável, criada com Gradio, que se abre automaticamente no navegador para uma experiência de uso otimizada.

  • Geração de Tabelas: Peça ao LLM para extrair dados específicos e formatá-los em uma tabela Markdown com cabeçalhos personalizados, ideal para análise.

🔧 Uso do Pipeline RAG

O pipeline RAG é um processo separado da conversão de HTML para Markdown, permitindo que você use a biblioteca de forma modular.

Passo 1: Gerar os Arquivos Markdown

Primeiro, use a função to_mkd para gerar os arquivos Markdown no diretório de saída (configurado em config.yaml). Seus arquivos .mkd servirão como a base de conhecimento para o sistema RAG.

from pymandua import to_mkd

# This will generate the .mkd files in the 'output' directory
to_mkd(
    urls=["https://pt.wikipedia.org/wiki/Luís_XIV_de_França"],
    keywords=["Luís XIV"],
    wait=2,
    threshold=90
)

Passo 2: Iniciar o Pipeline RAG

Em seguida, use a nova função start_rag_pipeline para processar os arquivos Markdown existentes e iniciar a interface de usuário. Você pode usar as configurações padrão do config.yaml ou sobrescrevê-las com parâmetros diretos para maior flexibilidade.

from pymandua import start_rag_pipeline

# Example 1: Use default settings from config.yaml
start_rag_pipeline()


# Example 2: Override models and providers via code
start_rag_pipeline(
    llm_model="llama3-chatqa:8b",
    embedding_model="nomic-embed-text",
    active_provider="ollama",
    persist_directory="./my-rag-db"
)

🖼️ Fluxo de Processo Completo

O diagrama de fluxo do seu projeto agora é expandido para incluir o pipeline RAG, ilustrando o processo completo da web até a análise com IA.

graph TD
    subgraph Web Scraping & Conversion
        User[User] --> to_mkd(to_mkd);
        to_mkd --> Output[output/];
    end

    subgraph RAG Pipeline
        Output --> start_rag_pipeline(start_rag_pipeline);
        start_rag_pipeline --> Ingest(Ingestion: Embeddings & Storage);
        Ingest --> VectorDB[Vector Database ] ;
        VectorDB --> Gradio[Gradio UI];
        Gradio --> LLM(LLM);
        Gradio --> VectorDB;
    end

    LLM --> Answers[Answers & Tables];

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pymandua-0.1.2.tar.gz (28.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pymandua-0.1.2-py3-none-any.whl (29.6 kB view details)

Uploaded Python 3

File details

Details for the file pymandua-0.1.2.tar.gz.

File metadata

  • Download URL: pymandua-0.1.2.tar.gz
  • Upload date:
  • Size: 28.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.6

File hashes

Hashes for pymandua-0.1.2.tar.gz
Algorithm Hash digest
SHA256 64379234ac48e41dfa82a8c542cd597611171d2d9718c8dec4dcea8f074d0ac9
MD5 0c91c827882d652c57ea51a0adb2f491
BLAKE2b-256 bf112331b004b7742e67fc2e2c161ce070457f880e5c0489727447be9662f8e7

See more details on using hashes here.

File details

Details for the file pymandua-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: pymandua-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 29.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.6

File hashes

Hashes for pymandua-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 304ba96fe2d3a0602bb300b9b6bbd187edcf8e94ea8607d42746739c8047c3f5
MD5 92a2c9d5696bc6be1711662d33114487
BLAKE2b-256 ec8d954a1cee20b6ddb82c6291fe45ee79ad421865aa080a46f39fd9056ff844

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page