FOLIO Auto Renew
An early preview of the Umbrellaleaf automatic renewals
folio-auto-renew provides a small set of async utilities to:
- Query FOLIO for loans that meet renewal criteria.
- Optionally filter loans by patron barcode patterns (optional).
- Submit renewal requests through the FOLIO circulation API.
This package is intended for libraries that want to automate recurring loan renewals using institution-specific policies.
Installation
python -m pip install folio-auto-renew
This library requires python 3.10+
Usage
from datetime import datetime, timezone
from folioclient import FolioClient
from folio_auto_renew import stream_loans, renew_loans
client = FolioClient(...)
renewable_loans = stream_loans(
client=client,
patron_barcode_patterns=None,
due_date=datetime.now(timezone.utc),
)
await renew_loans(client, renewable_loans)
Patron Barcode Filtering
Loans can be filtered to only patrons who have barcodes starting with certain prefixes. For example:
renewable_loans = stream_loans(
client=client,
patron_barcode_patterns=[
"2112",
"3335",
],
due_date=cutoff_date,
)
Passing None disables barcode filtering and processes all matching loans.
Customizing the base CQL query
The default query to identify loans is intended to be used by Five Colleges. Most libraries will need to replace this query before using the package.
The template is exposed as RENEWABLES_QUERY_TEMPLATE and can be replaced like this:
import folio_auto_renew
folio_auto_renew.RENEWABLES_QUERY_TEMPLATE = (
'status="Open" '
'AND itemStatus=="Checked Out" '
'AND loanPolicyId=="<your-loan-policy-id>" '
'AND dueDate<="{:%Y-%m-%dT%H:00:00%z}" '
'sortBy id/sort.ascending'
)
It is important to preserve the due-date format placeholder so the cutoff date can be injected correctly.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file folio_auto_renew-0.0.1.tar.gz.
File metadata
- Download URL: folio_auto_renew-0.0.1.tar.gz
- Upload date:
- Size: 10.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9d39d694980b6294b72ed3c47cfbf363bdcfa6230bb0e2c0930653c71f1189dd
|
|
| MD5 |
cd8dbbb319f652587a44c4c1efc7209c
|
|
| BLAKE2b-256 |
7a7ccacfe0c8b1fbd4ebb89182f6cd52a3038a027096a0f8aa6a08834f4a17e7
|
Provenance
The following attestation bundles were made for folio_auto_renew-0.0.1.tar.gz:
Publisher:
publish.yml on Five-Colleges-Incorporated/folio-auto-renew
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
folio_auto_renew-0.0.1.tar.gz -
Subject digest:
9d39d694980b6294b72ed3c47cfbf363bdcfa6230bb0e2c0930653c71f1189dd - Sigstore transparency entry: 2455787957
- Sigstore integration time:
-
Permalink:
Five-Colleges-Incorporated/folio-auto-renew@92e450c0fcb8a1b4a8b3faa6db92425d5a977713 -
Branch / Tag:
refs/tags/v0.0.1 - Owner: https://github.com/Five-Colleges-Incorporated
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@92e450c0fcb8a1b4a8b3faa6db92425d5a977713 -
Trigger Event:
push
-
Statement type:
File details
Details for the file folio_auto_renew-0.0.1-py3-none-any.whl.
File metadata
- Download URL: folio_auto_renew-0.0.1-py3-none-any.whl
- Upload date:
- Size: 9.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
59af3b78dde8cfa928c3c141789b6b205386a4b1d343035b5d6f1a4a6b1adddc
|
|
| MD5 |
a9b0fd4b8471ef9358b8bb19e65430a8
|
|
| BLAKE2b-256 |
d8959973fdedbc45a9ed4f4dd33095d1dd5e9da7d5a0f19caef5953bf7931411
|
Provenance
The following attestation bundles were made for folio_auto_renew-0.0.1-py3-none-any.whl:
Publisher:
publish.yml on Five-Colleges-Incorporated/folio-auto-renew
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
folio_auto_renew-0.0.1-py3-none-any.whl -
Subject digest:
59af3b78dde8cfa928c3c141789b6b205386a4b1d343035b5d6f1a4a6b1adddc - Sigstore transparency entry: 2455787989
- Sigstore integration time:
-
Permalink:
Five-Colleges-Incorporated/folio-auto-renew@92e450c0fcb8a1b4a8b3faa6db92425d5a977713 -
Branch / Tag:
refs/tags/v0.0.1 - Owner: https://github.com/Five-Colleges-Incorporated
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@92e450c0fcb8a1b4a8b3faa6db92425d5a977713 -
Trigger Event:
push
-
Statement type:
