2018-09-23 22:02:21 +02:00
|
|
|
# DSpace Statistics API
|
2018-09-18 13:11:29 +02:00
|
|
|
A quick and dirty REST API to expose Solr view and download statistics for items in a DSpace repository.
|
|
|
|
|
|
2018-09-18 13:09:29 +02:00
|
|
|
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
|
|
|
|
|
|
2018-09-18 13:19:14 +02:00
|
|
|
## Todo
|
|
|
|
|
|
2018-09-18 14:59:27 +02:00
|
|
|
- Ability to return a paginated list of items (on a different route?)
|
2018-09-23 08:52:36 +02:00
|
|
|
- Add API documentation
|
2018-09-23 23:35:00 +02:00
|
|
|
- Close up DB connection when gunicorn shuts down gracefully
|
|
|
|
|
- Better logging
|
2018-09-23 23:48:02 +02:00
|
|
|
- Return HTTP 404 when item_id is nonexistent
|
2018-09-18 13:19:14 +02:00
|
|
|
|
2018-09-18 13:16:07 +02:00
|
|
|
## License
|
|
|
|
|
This work is licensed under the [GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html).
|
