Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
A backend store for the Annotator
Python

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
annotator
tests
.gitignore
.travis.yml
LICENSE
README.md
annotator.cfg.example
run.py
setup.py
tox.ini

README.md

Annotator Store

This is a backend store for the Annotator.

Getting going

You'll need a recent version of Python (>=2.6) and ElasticSearch installed.

The quickest way to get going requires the pip and virtualenv tools (easy_install virtualenv will get them both). Run the following in the repository root:

pip -E pyenv install -e .
source pyenv/bin/activate
cp annotator.cfg.example annotator.cfg
python run.py

You should see something like:

* Running on http://127.0.0.1:5000/
* Restarting with reloader...

If you wish to customize the configuration of the Annotator Store, make your changes to annotator.cfg or dive into run.py.

Store API

The Store API is designed to be compatible with the Annotator. The annotation store, a JSON-speaking REST API, will be mounted at /api by default. See the Annotator documentation for details.

Running tests

We use nosetests to run tests. You can just pip install nosetests mock and then:

$ nosetests
....................................................
----------------------------------------------------------------------
Ran 52 tests in 3.233s

OK

Alternatively (and preferably), you should install Tox, and then run tox. This will run the tests against multiple versions of Python (if you have them installed).

Please open an issue if you find that the tests don't all pass on your machine, making sure to include the output of pip freeze.

Something went wrong with that request. Please try again.