mirror of
https://github.com/ilri/dspace-statistics-api.git
synced 2024-11-22 22:35:06 +01:00
Alan Orth
3327884f21
I've decided to use PostgreSQL instead of SQLite because the UPSERT support is available in versions of PostgreSQL we're alread running, whereas SQLite needs a VERY new (3.24.0) version that is not avail- able on any recent long-term support Ubuntu releases.
23 lines
801 B
Markdown
23 lines
801 B
Markdown
# 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. Requires PostgreSQL version 9.5 or greater for [`UPSERT` support](https://wiki.postgresql.org/wiki/UPSERT).
|
|
|
|
## Installation
|
|
Create a virtual environment and run it:
|
|
|
|
$ virtualenv -p /usr/bin/python3.6 venv
|
|
$ . venv/bin/activate
|
|
$ pip install falcon gunicorn SolrClient psycopg2-binary
|
|
$ gunicorn app:api
|
|
|
|
## Todo
|
|
|
|
- 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](https://www.gnu.org/licenses/gpl-3.0.en.html).
|