splitgill 3.0.0a0

Versioned search library

splitgill

Overview

Splitgill is a library providing functionality to create, update, and query versioned data. Uses MongoDB and Elasticsearch.

Note that this library is relatively stable but is still quite new and could still be significantly altered.

Split-gill mushroom

The split-gill mushroom is a fungus with a very high level of genetic diversity (a lot of versions, you could say).

Installation

splitgill can be installed from PyPI:

pip install splitgill

Or from Github:

pip install git+git://github.com/NaturalHistoryMuseum/splitgill.git#egg=splitgill

Splitgill requires:

• MongoDB >= version 6
• Elasticsearch >= version 8

This library has not been tested across many MongoDB and Elasticsearch versions, your mileage may vary, and it'd be worth running the test suite against the versions you're targeting before using this library in earnest.

Tests

Tests are run through docker-compose so that MongoDB and Elasticsearch are available for real testing.

To run the tests:

docker compose build
docker compose run test