api-feiras-livres

O api-feiras-livres é um projeto, desenvolvido com o framework Flask, para prover uma API REST, sobre os dados abertos de feiras livres que acontecem na cidade de São Paulo.

A prefeitura de São Paulo fornece esses dados abertos, por meio de arquivos CSV compactados (segue o link para download):

http://www.prefeitura.sp.gov.br/cidade/secretarias/upload/chamadas/feiras_livres_1429113213.zip

Essa API foi construida, baseada na estrutura de dados do arquivo (DEINFO_AB_FEIRASLIVRES_2014.csv), contida no zip acima.

Esse projeto foi desenvolvido por: Samuel Sampaio

Guia do usuário

Esta parte da documentação irá demonstrar como instalar e utilizar a aplicação api-feiras-livres.

• Requisitos básicos
  • Ferramentas básicas
  • Para executar em produção
  • Para executar os testes unitários
  • Para analises em modo debug
  • Para contruir essa documentação
• Instalação
  • Clonando o projeto do github
  • Criando um virtualenv para o projeto
  • Ativando o novo virtualenv ao seu path
  • Instalando as dependências (dentro do novo virtualenv)
    • Em produção
    • Em desenvolvimento (com as ferramentas de testes)
• Criando um banco de dados
  • Definindo o dados de conexão com banco de dados
    • Exemplo de conexão com o PostgreSQL
    • Exemplo de conexão com o MySQL
    • Exemplo de conexão com o SQLite
• Aplicando as alteração de banco de dados
• Executando a aplicação
  • Em modo desenvolvedor (runserver)
  • Em ambientes de produção (uwsgi)
• Utilizando a API
  • [POST] Cadastrando de uma nova feira
  • [GET] Obtendo dados de uma feira livre
  • [PUT] Alterando dos campos cadastrados de uma feira
  • [DELETE] Excluindo de uma feira através
  • [GET] Buscando de diversas feiras
• Executando os testes unitários
  • Como é executado os testes com o banco de dados
  • Executando os testes (com coverage simplificado)
  • Executando os testes (com coverage detalhado)
  • Analisando mais opções de testes
• Trabalhando com Models
  • Inserindo dados das feiras (via models)
  • Pesquisando feiras pelo código de registro (via models)
  • Apagando um registo do banco de dados (via models)
• Populando o banco de dados com o CSV
• Documentações
  • Build de arquivos html
  • Buildando automaticamente