Atualiza READMEs

README.md

@@ -29,12 +29,12 @@
 # Recursos
 
 - Extrai dados sobre:
-  - Casos totais no estado
+  - Casos confirmados no estado
   - Critérios de avaliação de casos
   - Status e evolução de casos
-  - Viagens de pacientes
   - Faixa etária, sexo, etnia e grau de escolaridade de pacientes
   - Sintomas e comorbidades de pacientes
+  - Viagens de pacientes
 - Filtro de casos por data
 - Estruturação e busca de casos por município
 
@@ -254,7 +254,7 @@ Você pode aprender mais sobre a API lendo a [documentação oficial](https://co
 
 ## Considerações finais
 
-Os dados são disponibilizados pelo Governo do Estado do Espírito Santo com a Superintendência Estadual de Comunicação Social do Espírito Santo (SECOM) e [podem ser encontrados aqui](https://coronavirus.es.gov.br/Noticias).
+Os dados são disponibilizados pelo Governo do Estado do Espírito Santo com a Superintendência Estadual de Comunicação Social do Espírito Santo (SECOM) e [podem ser encontrados aqui](https://coronavirus.es.gov.br/painel-covid-19-es).
 
 Devido à natureza dos dados, há uma chance considerável de o scraping parar de funcionar a qualquer momento. Para minimizar essa possibilidade, muitos testes automatizados foram escritos; em caso de discrepância, tentarei atualizar o pacote o mais rápido possível.
 

docs/index.md

@@ -2,9 +2,8 @@
 
 ## Índices
 
-* [Índice geral](genindex.html)
-* [Índice do módulo](py-modindex.html)
-
+- [Índice geral](genindex.html)
+- [Índice do módulo](py-modindex.html)
 <h1 align="center">
   <br>
   <a href="https://pypi.org/project/COVID19-ES-Py/">
@@ -18,7 +17,7 @@
 
 <h5 align="center">
 
-[![PyPI pyversions](https://img.shields.io/pypi/pyversions/COVID19-ES-Py.svg)](https://pypi.python.org/pypi/COVID19-ES-Py/) ![PyPI](https://img.shields.io/pypi/v/COVID19-ES-Py) ![Travis (.org)](https://img.shields.io/travis/AtilioA/COVID19-ES-Py) ![Read the Docs](https://img.shields.io/readthedocs/covid19-es-py) ![Codecov](https://img.shields.io/codecov/c/github/atilioa/covid19-es-py) ![Codacy grade](https://img.shields.io/codacy/grade/fcb128b62ff64a8ab51da5629bb11556)
+[![PyPI pyversions](https://img.shields.io/pypi/pyversions/COVID19-ES-Py.svg)](https://pypi.python.org/pypi/COVID19-ES-Py/) ![PyPI](https://img.shields.io/pypi/v/COVID19-ES-Py) ![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/atilioa/covid19-es-py) ![Travis (.org)](https://img.shields.io/travis/AtilioA/COVID19-ES-Py) ![Read the Docs](https://img.shields.io/readthedocs/covid19-es-py) ![Codecov](https://img.shields.io/codecov/c/github/atilioa/covid19-es-py) ![Codacy grade](https://img.shields.io/codacy/grade/fcb128b62ff64a8ab51da5629bb11556)
 
 ![PyPI - Downloads](https://img.shields.io/pypi/dm/covid19-es-py) [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-orange.svg)](https://www.gnu.org/licenses/gpl-3.0)
 
@@ -33,35 +32,156 @@
   <a href="#considerações-finais">Considerações finais</a>
 </p>
 
-
 # Recursos
-* Extração de URLs de boletins emitidos pela Secretaria de Estado da Saúde (SESA)
-* Extração de título, datas, corpo de notícia, números de casos e óbitos, etc, dos boletins
-* Pesquisa de casos por município
-* Pesquisa de boletim por data
-* Filtro de municípios com casos confirmados
+
+- Extrai dados sobre:
+  - Casos confirmados no estado
+  - Critérios de avaliação de casos
+  - Status e evolução de casos
+  - Faixa etária, sexo, etnia e grau de escolaridade de pacientes
+  - Sintomas e comorbidades de pacientes
+  - Viagens de pacientes
+- Filtro de casos por data
+- Estruturação e busca de casos por município
+
+<hr>
+
+- Descontinuado/deprecated a partir da versão `2.0.0`:
+
+  - Pesquisa de casos por município
+  - Pesquisa de boletim por data
+  - Filtro de municípios com casos confirmados
+  - Extração de URLs de boletins emitidos pela Secretaria de Estado da Saúde (SESA)
+  - Extração de título, datas, corpo de notícia, números de casos e óbitos, etc, dos boletins
+
+  Uma vez que a partir de 14/04 a SESA não emitirá mais boletins e em vez disso divulgará dados ao longo do dia pelo painel PowerBI, os recursos acima implementados através das classes `ScraperBoletim` e `Boletim` estão descontinuados. O pacote por padrão irá utilizar dados dos relatórios gerados pelo PowerBI, através das classes `LeitorRelatório` e `Relatório` (ver seção <a href="#como-usar">Como usar</a>). Não use recursos descontinuados a menos que tenha um motivo específico.
 
 # Instalação
-Atualmente, o COVID19-ES-Py possui suporte para Python 3.6+. Uma mesma release é feita ao PyPI e ao GitHub ao mesmo tempo, portanto use a fonte que achar mais conveniente.
+
+Atualmente, o COVID19-ES-Py possui suporte para Python 3.6+. Uma mesma release é feita ao PyPI e ao GitHub ao mesmo tempo, portanto você pode usar a fonte que achar mais conveniente.
 
 ## Pelo repositório PyPI
+
 Utilize seu gerenciador de pacotes preferido para instalar o pacote. Com `pip`:
 
 ```shell
 pip install COVID19-ES-Py
 ```
 
 ## Pelo código fonte
+
+### Através do `pip`
+
+É possível usar o `pip`, dentre outros gerenciadores de pacotes, para instalar o pacote através do repositório. Usando a release mais recente:
+
+```shell
+pip install https://github.com/AtilioA/COVID19-ES-Py/releases/latest
+```
+
+### Buildando com `setup.py`
+
 1. [Baixe a última release](https://github.com/AtilioA/COVID19-ES-Py/releases/latest) e extraia a pasta;
 2. Entre no diretório raiz do pacote pelo terminal e rode o comando `python setup.py install`
 
 # Como usar
 
-A API possui duas classes: `ScraperBoletim` e `Boletim`. A primeira é capaz de extrair links de boletins, buscar boletins por data, etc, usando objetos `Boletim` para fazer a interface para o programador. A segunda pode ser utilizada para extrair informações de um boletim específico. Confira os exemplos a seguir:
+A API possui duas classes principais: `LeitorRelatorio` e `Relatorio`. A primeira é capaz de filtrar relatórios por data, etc, usando objetos `Relatorio` para fazer a interface para o programador. A segunda pode ser utilizada para extrair informações de um relatório específico. Confira os exemplos a seguir:
 
 ## Exemplos
 
-### Inicializando o scraper e obtendo dados do último boletim:
+### Inicializando o leitor e obtendo dados do último relatório:
+
+```python
+import COVID19_ES_Py
+
+# Inicializando o leitor
+leitor = COVID19_ES_Py.LeitorRelatorio()
+
+# Carregando objeto Relatorio com dados do último arquivo csv emitido
+relatorio = leitor.carrega_ultimo_relatorio()  # Relatório do dia 17/04/2020
+relatorio.casos
+>>> {'AFONSO CLAUDIO': {'casosConfirmados': 2, 'obitos': 0},
+...
+    'VITORIA': {'casosConfirmados': 209, 'obitos': 8}}
+```
+
+Total de casos do relatório:
+
+```python
+relatorio.totalGeral
+>>> {'casosConfirmados': 952, 'obitos': 28}
+```
+
+### Pesquisando casos por município:
+
+Retorna objeto `Municipio` com casos do município no relatório:
+
+```python
+relatorio.busca_casos_municipio("Vitória")
+>>> "Município VITORIA:
+209 casos confirmados.
+8 óbitos."
+
+# A busca ignora espaços extras e capitalização
+relatorio.busca_casos_municipio("  santa teresa ")
+>>> "Município SANTA TERESA:
+4 casos confirmados.
+0 óbitos."
+
+# Também ignora caracteres especiais
+relatorio.busca_casos_municipio("AFONSO CLAUDIO")
+>>> "Município AFONSO CLAUDIO:
+2 casos confirmados.
+0 óbitos."
+
+relatorio.busca_casos_municipio("arapiraca")
+>>> exceptions.RelatorioError: O município "arapiraca" não foi encontrado no relatório. Pode ter ocorrido um erro de digitação ou o município não registrou casos de COVID-19.
+```
+
+Atributos da classe `Município`:
+
+- nome (`str`):
+  O nome do município.
+
+- casos (`list`): (`Caso`):
+  Uma lista de objetos do tipo Caso.
+
+- casosConfirmados (`int`):
+  O número de casos confirmados no município.
+
+- obitos (`int`):
+  O número de óbitos confirmados em decorrência de COVID-19 no município.
+
+### Pesquisando relatorio por data:
+
+Retorna objetos `Relatorio`:
+
+Filtrando até um dado dia:
+
+```python
+relatorio29_03 = leitor.filtra_casos_ate_dia("16/04/2020")
+>>> "Relatório do arquivo https://bi.static.es.gov.br/covid19/MICRODADOS.csv:
+Total geral: {'casosConfirmados': 935, 'obitos': 28}
+35 municípios infectados."
+```
+
+Filtrando apenas um dado dia:
+
+```python
+relatorio29_03 = leitor.filtra_casos_no_dia("16/04/2020")
+>>> "Relatório do arquivo https://bi.static.es.gov.br/covid19/MICRODADOS.csv:
+Total geral: {'casosConfirmados': 11, 'obitos': 0}
+5 municípios infectados."
+```
+
+A data de entrada [pode ser formatada de várias formas](https://covid19-es-py.readthedocs.io/pt_BR/latest/COVID19_ES_Py.html#COVID19_ES_Py.relatorio.LeitorRelatorio.filtra_casos_ate_dia).
+
+#### Exemplos descontinuados
+
+Exemplos de recursos descontinuados e que serão removidos na versão `3.0.0`.:
+
+Inicializando o scraper e obtendo dados do último boletim:
+
 ```python
 import COVID19_ES_Py
 
@@ -77,13 +197,16 @@ boletim.casos
 ```
 
 Total de casos do boletim:
+
 ```python
 boletim.totalGeral
 >>> {'casosConfirmados': '53 + 1*', 'casosDescartados': '411', 'casosSuspeitos': '1.105', 'totalCasos': '1.570'}
 ```
 
-### Pesquisando casos por município:
+Pesquisando casos por município:
+
 Retorna dicionário de casos do município no boletim:
+
 ```python
 boletim.pesquisa_casos_municipio("Vitória")
 >>> {'casosConfirmados': '18', 'casosDescartados': '96', 'casosSuspeitos': '142', 'totalCasos': '256'}
@@ -100,17 +223,22 @@ boletim.pesquisa_casos_municipio("arapiraca")
 >>> exceptions.BoletimError: O município "arapiraca" não foi encontrado no boletim. Pode ter ocorrido um erro de digitação ou o município não registrou casos de COVID-19.
 ```
 
-### Pesquisando boletim por data:
+Pesquisando boletim por data:
+
 Retorna o boletim da data de entrada, se houver:
+
 ```python
 boletim29_03 = scraper.pesquisa_boletim_data("29/03/2020")
 boletim29_03.pega_dataPublicacao_formatada()
 >>> "29/03/2020 19h25"
 ```
+
 A data de entrada [pode ser formatada de várias formas](https://covid19-es-py.readthedocs.io/pt_BR/latest/COVID19_ES_Py.html#COVID19_ES_Py.boletim.ScraperBoletim.pesquisa_boletim_data).
 
-### Filtrando municípios com casos confirmados:
+Filtrando municípios com casos confirmados:
+
 Retorna dicionário de dicionários com municípios com casos confirmados:
+
 ```python
 boletim05_04 = scraper.pesquisa_boletim_data("05/04/2020")
 
@@ -127,7 +255,14 @@ len(municipiosFiltrados)
 ```
 
 ## Considerações finais
-Os dados são disponibilizados pelo Governo do Estado do Espírito Santo com a Superintendência Estadual de Comunicação Social do Espírito Santo (SECOM) e [podem ser encontrados aqui](https://coronavirus.es.gov.br/Noticias).
+
+Se você está no Windows, a versão atual da biblioteca `rows` (`0.4.1`) possui um bug que impossibilita seu uso. Neste caso, instale a versão mais recente com:
+
+`pip install https://github.com/turicas/rows/archive/develop.zip#egg=rows`
+
+---
+
+Os dados são disponibilizados pelo Governo do Estado do Espírito Santo com a Superintendência Estadual de Comunicação Social do Espírito Santo (SECOM) e [podem ser encontrados aqui](https://coronavirus.es.gov.br/painel-covid-19-es).
 
 Devido à natureza dos dados, há uma chance considerável de o scraping parar de funcionar a qualquer momento. Para minimizar essa possibilidade, muitos testes automatizados foram escritos; em caso de discrepância, tentarei atualizar o pacote o mais rápido possível.
 

setup.py

@@ -52,7 +52,6 @@
         "wcwidth==0.1.9",
         "wrapt==1.12.1",
         "zipp==3.1.0",
-        "rows @ https://github.com/turicas/rows/archive/develop.zip"
+        "rows"
     ],
-    dependency_links=["https://github.com/turicas/rows/archive/develop.zip#egg=rows"],
 )