Skip to content

Commit

Permalink
Merge pull request #2 from kltm/patch-2
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
cmungall authored Jul 12, 2021
2 parents 192199c + 678601c commit bc17c12
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

## Installing

### pipenv

This requires python 3.7.x or later (as default python).

If you have pipenv installed:
Expand All @@ -12,6 +14,8 @@ cd sample-annotator
make test
```

### venv

For those using venv, you'll need something like:

```bash
Expand All @@ -23,6 +27,12 @@ pip install pipenv
PIPENV_IGNORE_VIRTUALENVS=1 make test
```

While there may be more concise ways of running commands like those below, this works:

```bash
PIPENV_IGNORE_VIRTUALENVS=1 pipenv run python -m sample_annotator.sample_annotator -R examples/report.tsv examples/gold.json
```

## What is it?

This is a python and flask API for performing annotation of samples from semi-structured or untidy data
Expand Down

0 comments on commit bc17c12

Please sign in to comment.