The Open Permissions Platform Template Service

Useful Links

• Open Permissions Platform
• Low level Design

Service Overview

This repository contains a Hello World application which can be used as a reference for Open Permissions Platform Services.

Running locally

To run the service locally:

pip install -r requirements/dev.txt
python setup.py develop
python template/

To show a list of available CLI parameters:

python template/ -h [--help]

To start the service using test.service.conf:

python template/ -t [--test]

Running tests and generating code coverage

To have a "clean" target from build artifacts:

make clean

To install requirements. By default prod requirement is used:

make requirements [REQUIREMENT=test|dev|prod]

To run all unit tests and generate a HTML code coverage report along with a JUnit XML report in tests/unit/reports:

make test

To run pyLint and generate a HTML report in tests/unit/reports:

make pylint

To run create the documentation for the service in _build:

make docs