1
0
mirror of https://github.com/ilri/dspace-statistics-api.git synced 2024-11-22 14:25:01 +01:00
dspace-statistics-api/README.md

747 B

DSpace 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
  • Close up DB connection when gunicorn shuts down gracefully
  • Better logging
  • Return HTTP 404 when item_id is nonexistent

License

This work is licensed under the GPLv3.