dspace-statistics-api/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.6. SolrClient (0.2.1) does not currently run in Python 3.7.0. Requires PostgreSQL version 9.5 or greater for [`UPSERT` support](https://wiki.postgresql.org/wiki/UPSERT).

## Installation
Create a virtual environment and run it:

    $ virtualenv -p /usr/bin/python3.6 venv
    $ . venv/bin/activate
    $ pip install -r requirements.txt
    $ gunicorn app:api

## Todo

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

## License
This work is licensed under the [GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html).
Rename project to DSpace Statistics API At first I called it "CGSpace" because I was making it specifically for our CGSpace DSpace repository, but the potential here is bigger than that! 2018-09-23 22:02:21 +02:00			`# DSpace Statistics API`
README.md: Update introduction 2018-09-18 13:11:29 +02:00			`A quick and dirty REST API to expose Solr view and download statistics for items in a DSpace repository.`

Update docs to remove SQLite stuff I've decided to use PostgreSQL instead of SQLite because the UPSERT support is available in versions of PostgreSQL we're alread running, whereas SQLite needs a VERY new (3.24.0) version that is not avail- able on any recent long-term support Ubuntu releases. 2018-09-24 23:55:35 +02:00			Written and tested in Python 3.6. SolrClient (0.2.1) does not currently run in Python 3.7.0. Requires PostgreSQL version 9.5 or greater for [`UPSERT` support](https://wiki.postgresql.org/wiki/UPSERT).
Add README.md 2018-09-18 13:09:29 +02:00
			`## Installation`
			`Create a virtual environment and run it:`

			`$ virtualenv -p /usr/bin/python3.6 venv`
			`$ . venv/bin/activate`
Add requirements.txt Generated with `pip freeze`. This is so I can pin the versions of packages that I've tested with as well as to allow Travis to test whether the project runs on various Pythons and to let GitHub in- form me of vulnerabilities in some libraries. 2018-09-25 10:02:50 +02:00			`$ pip install -r requirements.txt`
Add README.md 2018-09-18 13:09:29 +02:00			`$ gunicorn app:api`

README.md: Add todo list 2018-09-18 13:19:14 +02:00			`## Todo`

README.md: Add TODO about API documentation 2018-09-23 08:52:36 +02:00			`- Add API documentation`
README.md: Add more TODOs 2018-09-23 23:35:00 +02:00			`- Close up DB connection when gunicorn shuts down gracefully`
			`- Better logging`
README.md: Add TODO for nonexistent items 2018-09-23 23:48:02 +02:00			`- Return HTTP 404 when item_id is nonexistent`
README.md: Add todo list 2018-09-18 13:19:14 +02:00
Add GPLv3 license 2018-09-18 13:16:07 +02:00			`## License`
			`This work is licensed under the [GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html).`