dspace-statistics-api/README.md

21 lines
623 B
Markdown
Raw Normal View History

# 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?)
- Add API documentation
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).