alanorth/dspace-statistics-api
1
0
Fork 0
mirror of https://github.com/ilri/dspace-statistics-api.git synced 2024-11-25 23:58:18 +01:00
Code Releases Activity

README.md: Add TODO about API versions

Browse Source
This commit is contained in:
Alan Orth 2018-10-03 11:12:18 +03:00
parent 4291aecac4
commit 071c24535f
Signed by: alanorth
GPG Key ID: 0FB860CC9C45B1B9
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -7,12 +7,17 @@ A simple REST API to expose Solr view and download statistics for items in a DSp
- PostgreSQL version 9.5+ (due to [`UPSERT` support](https://wiki.postgresql.org/wiki/UPSERT)) - PostgreSQL version 9.5+ (due to [`UPSERT` support](https://wiki.postgresql.org/wiki/UPSERT))
- DSpace 4+ with [Solr usage statistics enabled](https://wiki.duraspace.org/display/DSDOC5x/SOLR+Statistics) - DSpace 4+ with [Solr usage statistics enabled](https://wiki.duraspace.org/display/DSDOC5x/SOLR+Statistics)
## Installation ## Installation and Testing
Create a virtual environment and run it: Create a Python virtual environment and install the dependencies:
$ python -m venv venv $ python -m venv venv
$ . venv/bin/activate $ . venv/bin/activate
$ pip install -r requirements.txt $ pip install -r requirements.txt
Set up the environment variables Solr and PostgreSQL:
$ export SOLR_SERVER=http://localhost:8080/solr
$
$ gunicorn app:api $ gunicorn app:api
## Deployment ## Deployment
@ -33,6 +38,7 @@ The API exposes the following endpoints:
- Better logging - Better logging
- Tests - Tests
- Check if database exists (try/except) - Check if database exists (try/except)
- Version API
## License ## License
This work is licensed under the [GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html). This work is licensed under the [GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html).