The Open Permissions Platform Resolution Service
================================================

This repository contains a service for resolving Open Permissions Platform Coalition IDs

Running locally
===============
To run the service locally:

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

To show a list of available CLI parameters:

```
python resolution/ -h [--help]
```

To start the service using test.service.conf:

```
python resolution/ -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
```

The Open Permissions Platform Resolution Service
================================================

Useful Links
============
* [Open Permissions Platform](http://openpermissions.org)
* [Low level Design](https://github.com/openpermissions/resolution-srv/blob/master/documents/markdown/low-level-design.md)

Service Overview
================
This repository contains a service for resolving Open Permissions Platform Coalition IDs

Running locally
---------------
To run the service locally:

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

To show a list of available CLI parameters:

```
python resolution/ -h [--help]
```

To start the service using test.service.conf:

```
python resolution/ -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
```

Add useful links to readme
Add useful links to readme
