alanorth/dspace-statistics-api
1
0
Fork 0
mirror of https://github.com/ilri/dspace-statistics-api.git synced 2024-06-26 16:13:47 +02:00
Code Releases Activity
A simple REST API to expose Solr view and download statistics for items in a DSpace repository.
96 Commits 9 Branches 36 Tags 1.3 MiB
Python 100%
b14c3eef4d
Go to file
Alan Orth b14c3eef4d
indexer.py: Use ujson instead of json 
Falcon optionally makes use of the ujson library to speed up media
(de)serialization, error serialization, and query string parsing.

See: https://falcon.readthedocs.io/en/stable/user/install.html
2018-09-27 09:51:40 +03:00
contrib contrib/dspace-statistics-indexer.timer: Fix syntax 2018-09-25 23:07:03 +03:00
.gitignore Update docs to remove SQLite stuff 2018-09-25 00:56:01 +03:00
.travis.yml .travis.yml: Add Python 3.7 2018-09-25 12:17:20 +03:00
app.py Return HTTP 404 when an item id is not found 2018-09-25 13:12:53 +03:00
CHANGELOG.md CHANGELOG.md. Add unreleased changes 2018-09-27 09:30:48 +03:00
config.py Use PostgreSQL instead of SQLite 2018-09-25 00:49:47 +03:00
database.py database.py: Use one line for psycopg2 imports 2018-09-26 22:23:24 +03:00
indexer.py indexer.py: Use ujson instead of json 2018-09-27 09:51:40 +03:00
LICENSE.txt Add GPLv3 license 2018-09-18 14:16:07 +03:00
README.md README.md: Add note about systemd units for deployment 2018-09-27 09:26:47 +03:00
requirements.txt requirements.txt: Use kazoo 2.5.0 2018-09-25 12:08:28 +03:00
solr.py Refactor Solr components 2018-09-23 13:24:30 +03:00

README.md

DSpace Statistics API

A simple REST API to expose Solr view and download statistics for items in a DSpace repository. This project contains a standalone indexing component and a WSGI application.

Requirements

Installation

Create a virtual environment and run it:

$ python -m venv venv
$ . venv/bin/activate
$ pip install -r requirements.txt
$ gunicorn app:api

Deployment

There are example systemd service and timer units in the contrib directory.

Using the API

The API exposes the following endpoints:

  • GET /items — return views and downloads for all items that Solr knows about¹. Accepts limit and page query parameters for pagination of results.
  • GET /item/id — return views and downloads for a single item (id must be a positive integer). Returns HTTP 404 if an item id is not found.

¹ We are querying the Solr statistics core, which technically only knows about items that have either views or downloads.

Todo

  • Add API documentation
  • Close up DB connection when gunicorn shuts down gracefully
  • Better logging
  • Tests
  • Check if database exists (try/except)

License

This work is licensed under the GPLv3.