mirror of
https://github.com/ilri/dspace-statistics-api.git
synced 2024-12-22 12:42:19 +01:00
A simple REST API to expose Solr view and download statistics for items in a DSpace repository.
Alan Orth
9e942736b1
It is much more efficient to cache view and download statistics in a database than to query Solr on demand (not to mention that it is not possible to page easily with facets in Solr). I decided to use SQLite because it is fast, native in Python 3, and doesn't require any extra steps during provisioning (assuming permissions are ok). |
||
---|---|---|
contrib | ||
.gitignore | ||
app.py | ||
CHANGELOG.md | ||
config.py | ||
database.py | ||
LICENSE.txt | ||
README.md | ||
solr.py |
CGSpace Statistics API
A quick and dirty REST API to expose Solr view and download statistics for items in a DSpace repository.
Written and tested in Python 3.6. SolrClient (0.2.1) does not currently run in Python 3.7.0.
Installation
Create a virtual environment and run it:
$ virtualenv -p /usr/bin/python3.6 venv
$ . venv/bin/activate
$ pip install falcon gunicorn SolrClient
$ gunicorn app:api
Todo
- Ability to return a paginated list of items (on a different route?)
- Add API documentation
License
This work is licensed under the GPLv3.