heronrs / pdv

A GraphQL API made with Flask

Ponto de Venda API

A GraphQL API where you can:

• Create a new PDV
• Search a PDV by ID
• Given a [lat, long] coordinate, return the nearest PDV in your area.

Production Deploy

The application should work in any Docker network environment(Docker-Swarm, Kubernetes, standalone Docker) as long as the port 8000 is fowarded and the follow environment variables are injected during runtime:

• MONGODB_URI(required) - MongoDB connection string in the form "mongodb://username:password@hostname:port/database"
• SECRET_KEY(required) - Used in Flask session management
• FLASK_ENV(optional) - Defaults to "production"
• FLASK_APP(optional) - Defaults do "pdv"
• FLASK_DEBUG(optional) - Defaults to 0
• LOG_LEVEL(optional) - Default to "INFO"

Local Development:

• Python 3.6 +
• Docker
• Docker Compose

Start webserver:

~/pdv: docker-compose up

GraphiQL and documentation should be available at http://localhost:8000/graphql

Running tests:

~/pdv: docker-compose run api pytest -vv

Load fixtures:

~/pdv: docker-compose run api flask load_fixtures

Linting:

~/pdv: docker-compose run api flake8

Auto format:

~/pdv: docker-compose run api black .

Sort imports:

~/pdv: docker-compose run isort

Todo

Track Issue graphql-python/graphene-mongo#62 and replace graphene-mongo for official repo library