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.
68 Commits 8 Branches 37 Tags 1.6 MiB
Python 100%
806d63137f
Go to file
Alan Orth 806d63137f
requirements.txt: Use kazoo 2.5.0 
SolrClient 0.2.1 currently depends on kazoo 2.2.1, but there is an
issue with Python 3.7 in kazoo <= 2.5.0. Kazoo 2.5.0 fixes the is-
sue with Python 3.7, and for my limited usage of SolrClient it se-
ems to work fine.

See: https://github.com/moonlitesolutions/SolrClient/issues/79
2018-09-25 12:08:28 +03:00
contrib contrib: Update environment settings in system units 2018-09-25 01:10:14 +03:00
.gitignore Update docs to remove SQLite stuff 2018-09-25 00:56:01 +03:00
.travis.yml Add .travis.yml 2018-09-25 11:08:01 +03:00
app.py Change / route to /items 2018-09-25 11:34:07 +03:00
CHANGELOG.md CHANGELOG.md: Move unreleased changes to version 0.3.0 2018-09-25 11:38:36 +03:00
config.py Use PostgreSQL instead of SQLite 2018-09-25 00:49:47 +03:00
database.py database.py: Use psycopg2.extras.DictCursor 2018-09-25 02:06:29 +03:00
indexer.py Update string substitution format 2018-09-25 02:19:29 +03:00
LICENSE.txt Add GPLv3 license 2018-09-18 14:16:07 +03:00
README.md README.md: Add note about Python 3.7 2018-09-25 12:07:58 +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 quick and dirty REST API to expose Solr view and download statistics for items in a DSpace repository.

Written and tested in Python 3.5, 3.6, and 3.7. Requires PostgreSQL version 9.5 or greater for UPSERT support.

Installation

Create a virtual environment and run it:

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

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).

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

Todo

  • Add API documentation
  • Close up DB connection when gunicorn shuts down gracefully
  • Better logging
  • Return HTTP 404 when item_id is nonexistent
  • Tests

License

This work is licensed under the GPLv3.