Feira API

Uma API Restful contendo todas as "feiras abertas" de São Paulo.

Instruções:

A aplicação suporta o inject de variáveis de ambiente através de um arquivo .env no root do projeto.

Variáveis de ambiente necessárias:

    DATABASE_URL(obrigatório) - Postgres String "postgres://user:pass@host:port/database"
    SECRET_KEY(obrigatório) - Controle interno do Django(Sessoes, csrf, etc)
    WORKERS(obrigatório) - Número de workers gunicorn
    DEBUG(opcional, default 0) - 1 ou 0
    LOG_LEVEL(opcional, default INFO) - Level do log

Os logs são direcionados para stdout e /var/log/app/gunicorn.log e /var/log/app/app.log

• Python 3.6 +

• Docker

• Docker-Compose

• Documentação:

  • Blueprint
  • Html
  • Postman

• Ambiente local:

    feiras:/$ sudo docker-compose up -d
    feiras:/$ firefox localhost:8000/api
  

• Carregar fixtures:

    feiras:/$ sudo docker-compose exec api make dump_data
  

• Testes:

    feiras:/$ sudo docker-compose exec api make test
    feiras:/$ sudo docker-compose exec api make test_report <-- gera relatório em htmlcov/
    feiras:/$ sudo docker-compose exec api pytest -k"test_name" <-- roda teste específico
  

• Formatação, lint:

    feiras:/$ sudo docker-compose exec api make lint
    feiras:/$ sudo docker-compose exec api make format
    feiras:/$ sudo docker-compose exec api make sort
  

• Gerar documentação:

    feiras:/$ sudo docker-compose exec api make doc
  

• Terminal interativo:

    feiras:/$ sudo docker-compose exec api bash