Lightweight analytics tool for Okapi-based services
Project description
LDLite
Copyright (C) 2021 The Open Library Foundation. This software is distributed under the terms of the Apache License, Version 2.0. See the file LICENSE for more information.
LDLite is a lightweight, open source reporting tool for Okapi-based services. It is part of the Library Data Platform project and provides basic LDP functions without requiring the server to be installed.
To install LDLite or upgrade to the latest version:
$ python -m pip install --upgrade ldlite
(On some systems it might be python3
rather than python
.)
To extract and transform data:
$ python
>>> import ldlite
>>> ld = ldlite.LDLite()
>>> ld.connect_okapi(url='https://folio-juniper-okapi.dev.folio.org/',
... tenant='diku',
... user='diku_admin',
... password='admin')
>>> db = ld.connect_db(filename='ldlite.db')
>>> _ = ld.query(table='g', path='/groups', query='cql.allRecords=1 sortby id')
ldlite: querying: /groups
ldlite: created tables: g, g__t, g__tcatalog
>>> ld.select(table='g__t')
__id | id | desc | expiration_offset_in_days | group
------+--------------------------------------+-----------------------+---------------------------+-----------
1 | 3684a786-6671-4268-8ed0-9db82ebca60b | Staff Member | 730 | staff
2 | 503a81cd-6c26-400f-b620-14c08943697c | Faculty Member | 365 | faculty
3 | ad0bc554-d5bc-463c-85d1-5562127ae91b | Graduate Student | | graduate
4 | bdc2b6d4-5ceb-4a12-ab46-249b9a68473e | Undergraduate Student | | undergrad
(4 rows)
>>> _ = ld.query(table='u', path='/users', query='cql.allRecords=1 sortby id')
ldlite: querying: /users
ldlite: created tables: u, u__t, u__t__departments, u__t__personal__addresses, u__t__proxy_for, u__tcatalog
>>> cur = db.cursor()
>>> _ = cur.execute("""
... CREATE TABLE user_groups AS
... SELECT u__t.id, u__t.username, g__t.group
... FROM u__t
... JOIN g__t ON u__t.patron_group = g__t.id;
... """)
>>> ld.export_excel(table='user_groups', filename='groups.xlsx')
Features
- Queries Okapi-based modules and transforms JSON data into tables for easier reporting
- Full SQL query support and export to CSV or Excel
- Compatible with DBeaver database tool
- Compatible with DuckDB, PostgreSQL, and Redshift database systems
- PostgreSQL/Redshift support enables:
- Sharing the data in a multiuser database
- Access to the data using more database tools
- Storing the data in an existing LDP database if available
- Runs on Windows, macOS, and Linux.
More examples
LDLite resources
-
Report bugs at Issues
-
Ask questions at Discussions
-
For notification of new releases: On the LDLite page in GitHub select Watch > Custom > Releases.
Other resources
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.