thenets/brasil.io

Backend da API do https://Brasil.IO/

Brasil.IO - Dados abertos para um Brasil mais ligado

O Problema

Muitos dados públicos brasileiros estão disponíveis (principalmente depois da criação da Lei de Acesso à Informação), mas não necessariamente acessíveis. Mesmo que a informação esteja disponível, nem sempre ela está disponível em um formato legível por máquina, ou utilizando um formato aberto, ou possui descrição (metadados) que facilitem a interpretação (manual ou automática) desses dados. Quanto menos acessível é uma informação, mais perto de ser fechada ela está.

Além do problema relativo à acessibilidade, não existe um lugar comum em que todos os dados disponíveis estejam organizados e catalogados, dificultando ainda mais o acesso (ou a descoberta que esse tipo de informação está disponível).

O objetivo do projeto não é concorrer com iniciativas correlatas do Governo (como o dados.gov.br) e de outras organizações -- pelo contrário, gostaríamos de disponibilizar os dados que essas organizações já disponibilizam, porém de forma integrada e estruturada, permitindo a qualquer um (independente de vínculo) possa disponibilizar dados, independente da fonte.

A Solução

O projeto Brasil.IO foi criado com o objetivo de ser referência para quem procura ou quer publicar dados abertos sobre o Brasil de forma organizada, legível por máquina e usando padrões abertos. O projeto foi idealizado e está sendo desenvolvido por Álvaro Justen, com a colaboração de outros desenvolvedores.

Colabore

Há duas formas de rodar o projeto em sua máquina, uma utilizando docker e outra utilizando o PostegreSQL. Vamos começar pela que utiliza o docker:

Primeiramente, certifique-se de que você tenha instalados:

• git
• pyenv com pyenv-virtualenv e Python 3.6.4
• docker

Siga os passos:

# Clonar o repositório:
git clone [email protected]:turicas/brasil.io.git

# Criar um virtualenv:
pyenv virtualenv 3.6.4 brasil.io

# Criar containers e ativar o virtualenv
cd brasil.io
source .activate

# Instalar dependências
pip install -r requirements.txt

# Criar schema e popular base de dados
python manage.py migrate
python manage.py update_data

Caso você escolha não utilizar o docker, siga os seguintes passos:

Certifique-se de que você tenha instalados:

• git
• pyenv com pyenv-virtualenv e Python 3.6.4
• postregreSQL

Após instalar o postgreSQL, crie o banco de dados que será utilizado pelo projeto. Como o docker não está sendo utilizado será necessário comentar algumas linhas no arquivo .activate.

Comente as seguintes linhas:

DOCKER_COMPOSE_FILE=docker-compose.yml

if [ -f "$DOCKER_COMPOSE_FILE" ]; then
   docker-compose -p $PROJECT_NAME -f $DOCKER_COMPOSE_FILE up -d
fi

e siga os passos:

# Clonar o repositório:
git clone [email protected]:turicas/brasil.io.git

# Criar um virtualenv:
pyenv virtualenv 3.6.4 brasil.io

# Modificar o arquivo .env para as configurações do seu Banco de Dados.
# Caso você use as configurações padrões, o arquivo será parecido com algo assim:

POSTGRES_HOST=localhost
POSTGRES_PORT=5432
POSTGRES_USER=postgres
POSTGRES_PASSWORD=<sua senha>
POSTGRES_DB=brasilio

DATABASE_URL=postgres://postgres:[email protected]:5432/brasilio

# Ativar o virtualenv
cd brasil.io
source .activate

# Instalar dependências
pip install -r requirements.txt

# Criar schema e popular base de dados
python manage.py migrate
python manage.py update_data

# Startar o server
python manage.py runserver

Para importar alguma base de dados para rodar no sistema é necessário o baixar o dump aqui.

Alguns arquivos demoram bastante para serem importados, pois são muito grandes. Um exemplo de arquivo menor é o dataset balneabilidade-bahia.

Após fazer o download do arquivo basta executar o seguinte comando:

$ python manage.py import_data balneabilidade-bahia balneabilidade-bahia.csv.xz

Deploying on Dokku

Dokku is a very small plataform-as-a-service software, it works like Heroku and can be used to easily deploy apps in your own infrastructure.

• On remote machine:
  • Install dokku
  • Install needed plugins:
    • dokku plugin:install https://github.com/dokku/dokku-postgres.git postgres
    • dokku plugin:install https://github.com/dokku/dokku-letsencrypt.git
  • Run dokku apps:create brasilio-web
• On local machine:
  • git remote add dokku dokku@HOSTNAME:brasilio-web
  • git push dokku master
• On remote machine:
  • dokku postgres:create brasilio-pgsql
  • dokku postgres:expose brasilio-pgsql
  • dokku postgres:link brasilio-pgsql brasilio-web
  • dokku config:set brasilio-web DEBUG=False
  • dokku ps:scale brasilio-web web=4
  • dokku domains:add brasilio-web brasil.io
  • dokku domains:add brasilio-web api.brasil.io
  • dokku domains:add brasilio-web www.brasil.io
  • dokku letsencrypt brasilio-web
  • Put .csv.xz files inside /root/data and run: dokku storage:mount brasilio-web /root/data:/data
  • dokku run brasilio-web /bin/bash
  • Inside container:
    • cd /app && python manage.py migrate
    • cd /app && python manage.py createsuperuser
    • cd /app && python manage.py update_data
    • cd /app && python manage.py import_data <dataset-slug> /data/<filename.csv.xz>

Licença

GNU General Public License version 3