Turn a IIIF top level collection into a paged Activity Stream. Please read the settings.py and docker_settings.py files for more information on setting up.
N.B. this code (for now) assumes a flat single level Collection, rather than nested collections.
This is a proof of concept illustration. Please read LICENSE for standard MIT license conditions.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Update settings.py for local/virtualenv usage.
Update docker_settings.py for docker usage.
collection The IIIF Collection to base the stream on
check_last_modified Set to True to dereference every manifest and check for last-modified headers to set the startTime
use_redis Use Redis for local caching. Docker usage assumes Redis, but local/virtualenv can/will use alternative caching methods if set to False.
event_ids Set to True to store local versions of the individual events, and serve up with dereferenceable IDs.
Other settings alter cache timeouts, and whether to cache requests to the IIIF services.
Docker settings will:
-
Bring up Redis
-
Use Redis for local caching of IIIF requests, and for activity streams results.
If check_last_modified is set to True, the first time a stream is loaded, it may be slow, but it should be fast thereafter.
Set redis_ttl, cache_requests_timeout and cache_timeout to suitably long values for your service.
Running with Docker is a quick and easy way to test locally.
N.B. Will build Redis and Flask/uWSGI apps and link them.
git clone https://github.com/mattmcgrattan/iiif-activity-streams.git
cd iiif-activity-streams/
Change the value for collection in docker_settings.py and ...
docker-compose up --build -d
Default will expose the application port on 8000.
Test by going to 'http://localhost:8000/as/'
N.B. Run with docker-compose up --build
To run it not daemonized, so you can see what's happening.
Has been tested with Python 2.7, Python 3.6, and PyPy.
git clone https://github.com/mattmcgrattan/iiif-activity-streams.git
cd iiif-activity-streams/
virtualenv -p Python3 .
source bin/activate
pip install -r requirements.txt
python activity_streams.py
to serve on localhost:5000 using Flask in debug mode.