brazilian-courts-scrappers/README.md

Data scrapper para fazer raspagem de dados de processos judiciais dos portais de tribunais do Brasil.

��

# Brazilian Courts Scrappers



Brazilian Courts Scrappers � uma biblioteca para fazer raspagem de dados (data scrapping) de processos judiciais dos portais de tribunais do Brasil.





## Instala��o



Para instalar utilizando npm, na pasta de seu projeto, rode o seguinte comando*:



```bash

  npm install brazilian-courts-scrappers

```

*Como n�o se trata de uma ferramenta de desenvolvimento, n�o imaginamos nenhuma raz�o para instalar como `--save-dev`.

## Uso/Exemplos



Brazilian Courts Scrappers � uma ferramenta criada para ser injentada como _content script_. No momento, a biblioteca n�o faz requisi��es para os sites de tribunais; em vez disso, ela realiza comandos na janela do navegador (embora nada impe�a que seja um navegador _headless_).



Para us�-la, basta seguir 3 passos: 



1. Importe a fun��o `identifyCorrectScrapper`, passando como argumento um documento HTML. A fun��o retornar� uma classe com o scrapper correspondente ao Tribunal (ela usa `document.URL` para identificar o tribunal).



2. Instancie essa classe, passando como par�metro o mesmo documento.



3. Voc� tem dois m�todos principais: `checkProcessoHomepage()`, que verifica se o documento passado � a p�gina inicial de um processo e retorna um `boolean`, e `fetchProcessoInfo()`, que realiza a raspagem de dados e retorna um objeto do tipo `ScrappedProcesso`, contendo as informa��es relevantes sobre o processo.



Por exemplo:



```javascript

import { identifyCorrectScrapper } from "brazilian-courts-scrappers";



const scrapperClass = identifyCorrectScrapper(document);

const scrapper = new scrapperClass(document);

if (!scrapper.checkProcessoHomepage()) return;

const processoInfo = await scrapper.fetchProcessoInfo()

console.log(processoInfo)

```





## Autores



- [@ironsand](https://github.com/ironsand-sou-eu)





## Licen�a



[Apache 2.0](https://choosealicense.com/licenses/apache-2.0/)