alanorth/dspace-statistics-api
1
0
Fork 0
mirror of https://github.com/ilri/dspace-statistics-api.git synced 2024-11-22 06:15:02 +01:00
Code Releases Activity
A simple REST API to expose Solr view and download statistics for items in a DSpace repository.
42 Commits 8 Branches 37 Tags 1.6 MiB
Python 100%
2cab456f16
Go to file
Alan Orth 2cab456f16
indexer.py: Use single items table with UPSERT 
I was using two separate tables for item views and downloads without
realizing that SQLite didn't support FULL OUTER JOIN, which would be
needed to get views and downloads for a given item in a single query.

Instead I can use one table with a default value of 0 for both views
and downloads, and then use "UPSERT" to populate the statistics. This
is a newish SQL concept that allows you to attempt an INSERT and then
specify an action to perform in case of conflict. This works well in
SQLite and actually simplifies my Python logic greatly!

Note that the "excluded" table qualifier is a special keyword that
allows you to reference the value that would have been inserted.

See: https://www.sqlite.org/lang_UPSERT.html
2018-09-24 14:19:50 +03:00
contrib contrib: Update some old CGSpace references to DSpace 2018-09-24 00:30:26 +03:00
.gitignore Add indexer.py 2018-09-23 16:47:48 +03:00
app.py Remove SOLR_CORE configuration variable 2018-09-24 00:20:54 +03:00
CHANGELOG.md CHANGELOG.md: Update unreleased notes 2018-09-24 00:30:58 +03:00
config.py Remove SOLR_CORE configuration variable 2018-09-24 00:20:54 +03:00
database.py Split database access into RW and RO 2018-09-24 00:00:05 +03:00
indexer.py indexer.py: Use single items table with UPSERT 2018-09-24 14:19:50 +03:00
LICENSE.txt Add GPLv3 license 2018-09-18 14:16:07 +03:00
README.md README.md: Add TODO for nonexistent items 2018-09-24 00:48:02 +03:00
solr.py Refactor Solr components 2018-09-23 13:24:30 +03:00

README.md

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.