Metadata-Version: 2.1
Name: splitgill
Version: 2.0.0
Summary: Versioned search library
Author-email: Josh Humphries <data@nhm.ac.uk>
License: MIT
Project-URL: repository, https://github.com/NaturalHistoryMuseum/splitgill
Project-URL: changelog, https://github.com/NaturalHistoryMuseum/splitgill/blob/main/CHANGELOG.md
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Requires-Python: !=3.0.*,!=3.1.*,>=2.7
Description-Content-Type: text/markdown
Provides-Extra: test
License-File: LICENSE

<!--header-start-->
# splitgill

[![Tests](https://img.shields.io/github/workflow/status/NaturalHistoryMuseum/splitgill/Tests?style=flat-square)](https://github.com/NaturalHistoryMuseum/splitgill/actions/workflows/main.yml)
[![Coveralls](https://img.shields.io/coveralls/github/NaturalHistoryMuseum/splitgill/master?style=flat-square)](https://coveralls.io/github/NaturalHistoryMuseum/splitgill)
[![Python version](https://img.shields.io/badge/python-2.7%20%7C%203.7%20%7C%203.8%20%7C%203.9-blue?style=flat-square)](https://www.python.org/downloads)
[![Docs](https://img.shields.io/readthedocs/splitgill?style=flat-square)](https://splitgill.readthedocs.io)
<!--header-end-->

## Overview
<!--overview-start-->
splitgill is a library providing base classes with the 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](https://doi.org/10.1093/molbev/msv153) (a lot of _versions_, you could say).

<!--overview-end-->

## Installation
<!--installation-start-->
splitgill can be installed from PyPI:
```shell
pip install splitgill
```

Or from Github:
```shell
pip install git+git://github.com/NaturalHistoryMuseum/splitgill.git#egg=splitgill
```
<!--installation-end-->

## Tests
<!--tests-start-->
Make sure you've installed the test requirements into your virtualenv - `pip install .[test]`, then:

 - To run the tests against all python versions this library is compatible with, run `tox`
 - To run the tests against the python version installed in your virtualenv, run `pytest`
 - To run the tests against the python version installed in your virtualenv and get a coverage report too, run `pytest --cov=splitgill`
<!--tests-end-->
