aboutsummaryrefslogtreecommitdiff

README for library_info project

This project is designed to make it easier for me to view the various items I have checked out from the libraries I visit. I have multiple accounts, and it is annoying to log in and out of multiple accounts. So I made my own status page.

Usage

Configuring

See config.py.example.

Example usage to generate a webpage

You could run this in cron. It wouldn't need to be run more than once a day.

./library_info_cli.py --output html > /var/www/html/library.html

Serving with DataTables

To take advantage of DataTables JS library, you need to serve files in this directory layout:

.
* library.html
| -- DataTables
     |-- datatables.min.css
     `-- datatables.min.js

Extending library_info

You can write your own plugin for deriving checkout items from a library website. If your library provides a public API, I don't believe you. See libraries/base.py or existing plugins as an example. The name of the file is part of the class name used in config.py.

Two plugins exist for some ILSes I have already encountered:

  • aspen
  • polaris

Design notes

Columns for items checked out:

  • title
  • format
  • picture
  • barcode
  • due date
  • possible renewal date
  • how many times renewed already
  • when checked out

Reserved items

  • position in line
  • date placed
  • format
  • title
  • picture
  • pickup location
  • status

plugin-based, so I can write a plugins/aspen.py with some standard format output.

Improvements

I still need to implement these features.

bgstack15