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 +```