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.
107 Commits 8 Branches 37 Tags 1.6 MiB
Python 100%
f2deba627c
Go to file
Alan Orth f2deba627c
.travis.yml: Run pip install as script 
Basically for now there are no tests so I just want to just check
that requirements.txt is correct and that all dependencies can be
installed.
2018-10-14 18:47:14 +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: Run pip install as script 2018-10-14 18:47:14 +03:00
app.py app.py: Iterate directly on cursor 2018-09-27 11:03:44 +03:00
CHANGELOG.md CHANGELOG.md: Update changes and move to 0.4.2 2018-10-05 00:19:18 +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: Fix logic error in SQL insert 2018-10-05 00:16:24 +03:00
LICENSE.txt Add GPLv3 license 2018-09-18 14:16:07 +03:00
README.md README.md: Update instructions 2018-10-14 18:45:40 +03:00
requirements.txt requirements.txt: pip freeze 2018-09-27 09:53:16 +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 and Testing

Create a Python virtual environment and install the dependencies:

$ python -m venv venv
$ . venv/bin/activate
$ pip install -r requirements.txt

Set up the environment variables for Solr and PostgreSQL:

$ export SOLR_SERVER=http://localhost:8080/solr
$ export DATABASE_NAME=dspacestatistics
$ export DATABASE_USER=dspacestatistics
$ export DATABASE_PASS=dspacestatistics
$ export DATABASE_HOST=localhost
$ 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)
  • Version API
  • Use JSON in PostgreSQL

License

This work is licensed under the GPLv3.