Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/PostmonAPI/postmon

Uma API para consulta de informações relacionadas a endereçamento e entrega no Brasil.
https://github.com/PostmonAPI/postmon

Last synced: 3 days ago
JSON representation

Uma API para consulta de informações relacionadas a endereçamento e entrega no Brasil.

Host: GitHub
URL: https://github.com/PostmonAPI/postmon
Owner: PostmonAPI
License: gpl-3.0
Created: 2012-12-04T14:16:01.000Z (almost 12 years ago)
Default Branch: master
Last Pushed: 2024-10-31T15:20:14.000Z (3 days ago)
Last Synced: 2024-10-31T16:27:01.500Z (3 days ago)
Language: Python
Homepage: http://www.postmon.com.br
Size: 235 KB
Stars: 656
Watchers: 39
Forks: 81
Open Issues: 69
Metadata Files:
- Readme: README.md
- License: COPYING

Awesome Lists containing this project

starred-awesome - postmon - Uma API para consulta de informações relacionadas a endereçamento e entrega no Brasil. (HTML)

README

Postmon [](http://travis-ci.org/PostmonAPI/postmon) [![Coverage Status](https://coveralls.io/repos/github/PostmonAPI/postmon/badge.svg?branch=master)](https://coveralls.io/github/PostmonAPI/postmon?branch=master)

==========
API para consulta de CEP's e relacionados

Requisitos do ambiente de desenvolvimento
---------------------------------------------
* MongoDB
* Python 2.7
* iPython (recomendado)

Requisitos do ambiente Python
-----------------------

As dependências estão listadas no arquivo requirements.txt.

* requests
* pymongo
* bottle
* nosetests
* webtest
* packtrack
* celery

Rodando testes
----------------
Executar o comando:

make test

na raiz do projeto.

Rodando a aplicação localmente na porta 9876
--------------------------------

$ python PostmonServer.py

$ ipython -i PostmonServer.py
>> _standalone()

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

Para rodar o [Scheduler](#scheduler):

$ celery worker -B -A PostmonTaskScheduler -l info

Recomenda-se a utilização do [Supervisord](http://supervisord.org/) para manter o Celery rodando. Exemplo de configuração para o _supervisord.conf_:

[program:celeryd]
command=celery worker -B -A PostmonTaskScheduler -l info
directory=POSTMON_HOME/repositorio
stdout_logfile=POSTMON_LOG_DIR/celeryd.log
stderr_logfile=POSTMON_LOG_DIR/celeryd_err.log
autostart=true
autorestart=true
startsecs=10
stopwaitsecs=600

Executando a aplicação no Docker
------------------------

Se você tem o Docker instalado, pode fazer o build da imagem e rodar o Postmon em um container.

```bash
$ docker build -t postmon .
$ docker run -d -p 80:9876 postmon
```

Acesse o endereço `http:///v1/cep/`, por exemplo `http://127.0.0.1/v1/cep/01311940`.

MongoDB com autenticação
------------------------

Se o seu MongoDB possui autenticação habilitada você deverá configurar o banco do postmon
e também exportar duas variavéis de ambiente.

```javascript
mongo
> use postmon
> db.addUser('admin', '123456')
```

Agora que seu Mongo está com password exporte as variaveis de ambiente.

```bash
export POSTMON_DB_USER=admin
export POSTMON_DB_PASSWORD=123456
```

Para conectar em um banco remoto exporte a variável de ambiente:
```bash
export POSTMON_DB_HOST=
```

Scheduler
---------

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).

O Celery usa, como Broker, a mesma instância do MongoDB utilizada no módulo de CEP.

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/).

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:

$ celery worker -B -A PostmonTaskScheduler -l info -s /novo/caminho/para/arquivo/celerybeat_schedule

IBGE
-------------

O Postmon fornece as seguintes informações extraídas do site do IBGE:

* Código do município/UF
* Área territorial (em km²)

Essas informações estão presentes nos atributos *estado_info* e *cidade_info* da rota de busca de _cep_, bem como nas seguintes rotas:

* /uf/{sigla-uf}
* /cidade/{sigla-uf}/{nome-cidade}

Exemplos:

* /uf/SP
* /cidade/SP/São Paulo
* /cidade/SP/Araraquara
* /cidade/RJ/Macaé

A rotina de atualização desses dados está configurada para rodar diariamente.

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see .