From 74e5fc7a16e29095ac80b4079f6bb618a7fdb319 Mon Sep 17 00:00:00 2001 From: filmaj Date: Tue, 26 Jun 2018 18:41:53 -0500 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20document=20requirements=20and=20?= =?UTF-8?q?how=20to=20run=20the=20tests.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 1ac30e54..9a2f800d 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,24 @@ # Mordred [![Build Status](https://travis-ci.org/grimoirelab/mordred.svg?branch=master)](https://travis-ci.org/grimoirelab/mordred) Mordred is the tool used to coordinate the execution of the GrimoireLab platform. + +## Requirements + +One good way of having an immediate sense of requirements is to look through our [`.travis.yml`](.travis.yml) file to see what our CI does to validate Mordred. + +1. Ensure you have all the [supporting systems](https://chaoss.github.io/grimoirelab-tutorial/before-you-start/supporting-systems.html) Mordred needs. In particular, make sure [ElasticSearch is installed and running](https://chaoss.github.io/grimoirelab-tutorial/before-you-start/supporting-systems.html#installing-elasticsearch). (psst: [you can do this via a docker image faster](https://chaoss.github.io/grimoirelab-tutorial/before-you-start/supporting-systems.html#installing-elasticsearch-and-kibana-from-a-docker-container)) +2. Prepare and activate a `python3` virtualenv by following our [tutorial instructions](https://chaoss.github.io/grimoirelab-tutorial/before-you-start/installing-grimoirelab.html#preparing-a-virtualenv). +3. Install dependencies by following the steps in our [`.travis.yml file`](.travis.yml). At the time of this writing, those are: + ```sh + pip install pandas==0.18.1 + pip install httpretty==0.8.6 + pip install -r "requirements.txt" + pip install flake8 + pip install coveralls + ``` +## Testing + +```sh +flake8 . +cd tests && ./runtests.py +```