ows-contracts
=====================================

ows-contracts microservice supports operations related to contract information. Today, contract information is stored at the vendor level.

ows-contracts endpoints support:
* retrieving whether a vendor is a mechanical admin (MechAdmin) client
* retrieving whether a sub-account belongs to a vendor that is a MechAdmin client.

In the future ows-contracts will support more operations related to contract information.

## Getting Started

### Installation

The installation is very straightforward, but make sure you are using at least
python 3.6. If you use a Mac, you can install it using `brew`. If you use
Windows, just ask for a remote VM that has it installed for you.

```bash

$ pyvenv env
(env) $ . env/bin/activate
(env) $ pip install -r requirements.txt
(env) $ pip install -r requirements-dev.txt
```

### Running

When all dependencies have been installed, you can run the flask application
on your local instance by running:

```bash
(env) $ python dev.py
```

By using the development server, you will have access to specific features that
are not necessarily available in production, such as the exception tracer.

### Testing

To run the tests, all you have to do is to run:

```bash
(env) $ py.test tests/ --cov contracts --cov-report term-missing
(env) $ flake8 contracts/ tests/
```