Skip to content

Commit 31371f2

Browse files
Update README.md with PostmonTaskScheduler and IBGE info #56
1 parent f765c7a commit 31371f2

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ As dependências estão listadas no arquivo requirements.txt.
2020
* nosetests
2121
* webtest
2222
* packtrack
23+
* celery
2324

2425
Rodando testes
2526
----------------
@@ -41,6 +42,9 @@ ou
4142

4243
Caso queira rodar em outra porta, basta passá-la como parametro no chamado do _standalone
4344

45+
Para rodar o [Scheduler](#Scheduler):
46+
47+
$ celery worker -B -A PostmonTaskScheduler -l info
4448

4549
MongoDB com autenticação
4650
------------------------
@@ -60,3 +64,38 @@ Agora que seu Mongo está com password exporte as variaveis de ambiente.
6064
export POSTMON_DB_USER=admin
6165
export POSTMON_DB_PASSWORD=123456
6266
```
67+
68+
Scheduler
69+
---------
70+
71+
O Postmon conta com um scheduler baseado na ferramenta [Celery](http://www.celeryproject.org/). Até o momento, a única funcionalidade implementada nessa estrutura é a rotina de coleta de dados do [IBGE](#IBGE).
72+
73+
O Celery usa, como Broker, a mesma instância do MongoDB utilizada no módulo de CEP.
74+
75+
O comando apresentado na seção [rodando a aplicação](#rodando-a-aplicação-localmente-na-porta-9876) pode ser quebrado em dois caso seja necessário rodar o Celery Worker separado do Celery Beat. Para mais informações sobre essa questão leia a [documentação do Celery](http://docs.celeryproject.org/en/latest/).
76+
77+
Além do Broker, o Celery Beat depende internamente de uma base de dados, criada automaticamente na primeira execução, onde são armazenadas informações sobre os schedules. Por padrão essa base fica em um arquivo chamado _celerybeat_schedule_, criado no diretório onde o Celery Beat foi executado. Esse local pode ser alterado através do switch -s, conforme exemplo abaixo:
78+
79+
$ celery worker -B -A PostmonTaskScheduler -l info -s /novo/caminho/para/arquivo/celerybeat_schedule
80+
81+
IBGE
82+
-------------
83+
84+
O Postmon fornece as seguintes informações extraídas do site do IBGE:
85+
86+
* Código do município/UF
87+
* Área territorial (em km²)
88+
89+
Essas informações estão presentes nos atributos _estado_info_ e _cidade_info_ da rota de busca de _cep_, bem como nas seguintes rotas:
90+
91+
* /uf/{sigla-uf}
92+
* /cidade/{sigla-uf}/{nome-cidade}
93+
94+
Exemplos:
95+
96+
* /uf/SP
97+
* /cidade/SP/São Paulo
98+
* /cidade/SP/Araraquara
99+
* /cidade/RJ/Macaé
100+
101+
A rotina de atualização desses dados está configurada para rodar diariamente.

0 commit comments

Comments
 (0)