diff --git a/indexer.py b/indexer.py index 242316d..ccaeb6e 100755 --- a/indexer.py +++ b/indexer.py @@ -1,8 +1,36 @@ #!/usr/bin/env python # -# Tested with Python 3.6 -# See DSpace Solr docs for tips about parameters -# https://wiki.duraspace.org/display/DSPACE/Solr +# indexer.py +# +# Copyright 2018 Alan Orth. +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +# +# --- +# +# Connects to a DSpace Solr statistics core and ingests item views and downloads +# into a SQLite database for use with other applications (an API, for example). +# +# This script is written for Python 3 and requires several modules that you can +# install with pip (I recommend setting up a Python virtual environment first): +# +# $ pip install SolrClient +# +# See: https://solrclient.readthedocs.io/en/latest/SolrClient.html +# See: https://wiki.duraspace.org/display/DSPACE/Solr +# +# Tested with Python 3.5 and 3.6. from database import database_connection_rw from solr import solr_connection