Skip to content

Commit

Permalink
Add link to venv python guide in README
Browse files Browse the repository at this point in the history
  • Loading branch information
yohanboniface committed Oct 31, 2017
1 parent 0582591 commit ea243b7
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

Run search queries against a geocoder that supports [geocodejson spec](https://github.com/geocoders/geocodejson-spec).

## Intalling
## Intalling

You should have created a python 3.4 virtualenv environment, then:
- create a python >= 3.4 [virtualenv](http://docs.python-guide.org/en/latest/dev/virtualenvs/) environment
- `git clone https://github.com/geocoders/geocoder-tester && cd geocoder-tester`
- `pip install -r requirements.txt`

pip install -r requirements.txt

## Running
## Running

Simply:

Expand Down Expand Up @@ -55,7 +55,7 @@ Then compare when running a new version
py.test --compare-report path/to/report.log


## Adding search cases
## Adding search cases

We support python, CSV and YAML format.

Expand All @@ -74,12 +74,12 @@ You generally want to use YAML format if you are managing tests by hand in your
text editor, CSV if you are generating test cases from a script, and python test
cases if you need more control.

### Python
### Python

They are normal python tests. Just note that you have two utils in `base.py`:
`search` and `assert_search` that can do a lot for you.

### CSV
### CSV

One column is mandatory: `query`, where you store the query you make.
Then you can add as many `expected_xxx` columns you want, according to what
Expand Down

0 comments on commit ea243b7

Please sign in to comment.