Skip to content

Commit 30778cd

Browse files
committed
📝 document requirements and how to run the tests.
1 parent 44e4aea commit 30778cd

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,24 @@
11
# SirMordred [![Build Status](https://travis-ci.org/grimoirelab/mordred.svg?branch=master)](https://travis-ci.org/grimoirelab/mordred)
22

33
SirMordred is the tool used to coordinate the execution of the GrimoireLab platform.
4+
5+
## Requirements
6+
7+
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 SirMordred.
8+
9+
1. Ensure you have all the [supporting systems](https://chaoss.github.io/grimoirelab-tutorial/before-you-start/supporting-systems.html) SirMordred 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))
10+
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).
11+
3. Install dependencies by following the steps in our [`.travis.yml file`](.travis.yml). At the time of this writing, those are:
12+
```sh
13+
pip install pandas==0.18.1
14+
pip install httpretty==0.8.6
15+
pip install -r "requirements.txt"
16+
pip install flake8
17+
pip install coveralls
18+
```
19+
## Testing
20+
21+
```sh
22+
flake8 .
23+
cd tests && ./runtests.py
24+
```

0 commit comments

Comments
 (0)