diff options
| -rw-r--r-- | README.md | 13 |
1 files changed, 12 insertions, 1 deletions
@@ -14,9 +14,15 @@ --> # 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 -Because this does not need to be a complex flask web app, it is designed as a cli tool. Run it in cron no more often than once a day. + +## Configuring +See [config.py.example](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 @@ -29,8 +35,12 @@ To take advantage of [DataTables JS library](https://datatables.net/), you need |-- 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](libraries/base.py) or existing plugins as an example. The name of the file is part of the class name used in `config.py`. + # Design notes Columns for items checked out: + * title * format * picture @@ -46,3 +56,4 @@ plugin-based, so I can write a plugins/aspen.py with some standard format output I still need to implement these features. * add reservations for each library +* add library card expiration date |