https://github.com/lol768/warwick-libraryhog
Hogs library items by renewing them.
https://github.com/lol768/warwick-libraryhog
library renewal university
Last synced: 3 months ago
JSON representation
Hogs library items by renewing them.
- Host: GitHub
- URL: https://github.com/lol768/warwick-libraryhog
- Owner: lol768
- License: gpl-3.0
- Created: 2016-11-24T21:04:23.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-05-30T13:12:27.000Z (almost 8 years ago)
- Last Synced: 2025-02-24T09:47:02.614Z (3 months ago)
- Topics: library, renewal, university
- Language: Python
- Size: 15.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
LibraryHog
==========
A simple script which automatically renews all items checked out from the University of Warwick's library.
A note on renewals
------------------
Renewals are possible if:
* The item is not on hold
* At least a day has passed since the last renewal
When renewals happen, the due date is extended to the current date + the standard loan length (2 weeks).
Thus, to maximise the time you can have a single book without returning it, it is best to make a renewal attempt
every day:
* If another library user places a hold, you will have renewed as close as possible to the hold, and will get the
largest amount of the standard loan length
* Renewing every day like this will continuously move the due date one day in the future, so at all points in time
there will be two weeks to read the book
A note on holds
---------------
When a library user requests a hold on a book, the hold is **sent to everyone** who has the title in question out on loan. This stops everyone from renewing the title until one of the copies is returned. As a result, the "loser" is whoever has the closest due date because they have no choice but to return the book by this date or face a fine. Once a hold is fulfilled it becomes possible to renew the book again.
This means that if you use this script and there are multiple copies of a book, you should *never* need to return the book (assuming less holds than book copies are requested). You'll still receive emails about holds as normal, but you can just ignore them.
NB: if all of the other users who are also sent the hold notificaton are using a script like this, everyone will have the same due date. This seems like an unlikely scenario, but if you're not careful you'll end up with a fine - if the renews continuously fail up until the due date you'll need to return the book. The best approach to take when this happens is to immediately request a hold as soon as the title is returned.
Using the script
----------------
Authentication is via LDAP (not WebSignOn), so the script needs to know your Warwick usercode and password. It is
suggested that you carefully read through the script prior to using it in the interests of security. It's very simple
and well-documented.
You can either provide the credentials at runtime (the script will prompt you) or set two environment variables:
```
export WARWICK_USERNAME="uxxxxxxx"
export WARWICK_PASSWORD="password123"
python3 main.py
```
The latter approach is suggested for automation. If you're planning on using the script with a cronjob, it's suggested
to only run it once a day at 0030 or similar:
```
30 0 * * * /path/to/lib_hog.sh
```
If you are going to store your password for this use, you must ensure it is done in a secure manner to comply with
the ITS AUP.
TODO
----
* Watch recently returned items (due to a hold) and request a hold as soon as they are checked out.
Motivation and ethical considerations
-------------------------------------
Motivations:
* Different library users are arbitrarily given different loan lengths. University staff take out books for the entire
academic year by default which forces use of holds to try and take out items which would otherwise be available.
* Holds placed very close to the due date on an item you were planning to renew are inconvenient. The fine amount
is also impacted.
Ethical considerations:
* The script should not be used to take out an item for longer than is required to read/refer to/make notes on it.