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.
26 Commits 8 Branches 37 Tags 1.6 MiB
Python 100%
ea85393b13
Go to file
Alan Orth ea85393b13
app.py: Use parameterized URI instead of query for /item 
Falcon's get_param_as_int() is really nice in that it gets a query
parameter and does validation for you, but I really wanted to have
cleaner URIs for API routes so I am now using a route URI template
with a field converter. This is cleaner, but means that parameters
not matching the template will return HTTP 404.

See: https://falcon.readthedocs.io/en/stable/api/routing.html#field-converters
2018-09-23 16:23:33 +03:00
contrib Add example systemd unit for statistics API 2018-09-23 07:50:04 +03:00
.gitignore Add .gitignore 2018-09-18 14:09:53 +03:00
app.py app.py: Use parameterized URI instead of query for /item 2018-09-23 16:23:33 +03:00
CHANGELOG.md CHANGELOG.md: Add note about Solr connection refactor 2018-09-23 13:27:43 +03:00
config.py Add vim modeline to all Python files 2018-09-23 11:33:26 +03:00
LICENSE.txt Add GPLv3 license 2018-09-18 14:16:07 +03:00
README.md README.md: Add TODO about API documentation 2018-09-23 09:52:36 +03:00
solr.py Refactor Solr components 2018-09-23 13:24:30 +03:00

README.md

CGSpace 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

License

This work is licensed under the GPLv3.