Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
A backend store for the Annotator
Python JavaScript

This branch is 1 commit ahead, 285 commits behind openannotation:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
annotator
instance
tests
.gitignore
.hgignore
.hgtags
README.md
bookmarklet.config.json
bootstrap.py
console.py
run.py
run_tests.py
setup.py

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
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, copy instance/annotator.cfg.example to instance/annotator.cfg and make your changes there.

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

Simply run python run_tests.py to run the test suite

$ python run_tests.py
.....................
----------------------------------------------------------------------
Ran 21 tests in 0.502s

OK

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.