Skip to main content

Find books at your local library

Project description

Build Status Code Coverage Code style: black

Bibliophile backend

This is a Python-based tool for finding books at the local library.

It parses your "to read" list from and checks which items are available at a library of your choosing.

Looking for a GUI?

This repository is all you need to use the tool locally via the command line. For a web-based user interface, see Bibliophile.

Can I use this?

If you live near one of the ~190 public libraries using the BiblioCommons system, then running this software should work for you. It relies on undocumented APIs, so your mileage may vary.

  1. Apply for a Goodreads Developer Key.

  2. Obtain your Goodreads user id

  3. [Optional] Set both these values in your .bashrc

    export GOODREADS_USER_ID=123456789
    export GOODREADS_DEV_KEY=whatever-your-actual-key-is
  4. Install Poetry

  5. Run the script!

    make  # One-time setup of dependencies
    ./ --biblio seattle  # Set to your own city!

Make sure you adhere to the terms of Goodreads' API, and have fun.

Other options

You can choose to show only titles available at your local branch, select titles from another Goodreads shelf, etc. Pass --help to see all options:

usage: [-h] [--branch BRANCH] [--shelf SHELF] [--biblio BIBLIO]
                 [--csv CSV]
                 [user_id] [dev_key]

See which books you want to read are available at your local library.

positional arguments:
  user_id          User's ID on Goodreads
  dev_key          Goodreads developer key. See

optional arguments:
  -h, --help       show this help message and exit
  --branch BRANCH  Only show titles available at this branch. e.g. 'Fremont
  --shelf SHELF    Name of the shelf containing desired books
  --biblio BIBLIO  subdomain of (seattle, vpl, etc.)
  --csv CSV        Output results to a CSV of this name.

Cloud-based deployment

This may also be deployed as Lambda functions in AWS. See the Bibliophile README for instructions.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bibliophile-1.0.0.tar.gz (28.0 kB view hashes)

Uploaded source

Built Distribution

bibliophile-1.0.0-py3-none-any.whl (31.6 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page