{"id":23366854,"url":"https://github.com/davidcain/bibliophile-backend","last_synced_at":"2025-04-07T23:16:11.207Z","repository":{"id":62560059,"uuid":"313398994","full_name":"DavidCain/bibliophile-backend","owner":"DavidCain","description":"Find books at my local library (CLI only)","archived":false,"fork":false,"pushed_at":"2020-11-25T20:43:19.000Z","size":1134,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-14T00:27:03.662Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DavidCain.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-11-16T18:58:05.000Z","updated_at":"2021-07-22T20:14:04.000Z","dependencies_parsed_at":"2022-11-03T14:00:26.514Z","dependency_job_id":null,"html_url":"https://github.com/DavidCain/bibliophile-backend","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DavidCain%2Fbibliophile-backend","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DavidCain%2Fbibliophile-backend/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DavidCain%2Fbibliophile-backend/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DavidCain%2Fbibliophile-backend/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DavidCain","download_url":"https://codeload.github.com/DavidCain/bibliophile-backend/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247744329,"owners_count":20988783,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-21T14:18:54.418Z","updated_at":"2025-04-07T23:16:11.186Z","avatar_url":"https://github.com/DavidCain.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"![CI](https://github.com/DavidCain/bibliophile-backend/workflows/CI/badge.svg?branch=master)\n[![Code Coverage](https://codecov.io/gh/DavidCain/bibliophile-backend/branch/master/graph/badge.svg)](https://codecov.io/gh/DavidCain/bibliophile-backend)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)\n\n# Bibliophile backend\nThis is a Python-based tool for finding books at the local library.\n\nIt parses your \"to read\" list from Goodreads.com and checks which items\nare available at a library of your choosing.\n\n## Looking for a GUI?\nThis repository is all you need to use the tool locally via the command line.\nFor a web-based user interface, see [Bibliophile][bibliophile-repo].\n\n# Can I use this?\nIf you live near one of the ~190 public libraries using the BiblioCommons\nsystem, then running this software should work for you. It relies on\nundocumented APIs, so your mileage may vary.\n\n1. Apply for a [Goodreads Developer Key][goodreads-api].\n2. Obtain your Goodreads user id\n3. [Optional] Set both these values in your `.bashrc`\n\n    ```sh\n    export GOODREADS_USER_ID=123456789\n    export GOODREADS_DEV_KEY=whatever-your-actual-key-is\n    ```\n4. [Install Poetry][poetry-install]\n5. Run the script!\n\n    ```sh\n    make  # One-time setup of dependencies\n    ./lookup.py --biblio seattle  # Set to your own city!\n    ```\n\nMake sure you adhere to the terms of [Goodreads' API][goodreads-api-terms], and\nhave fun.\n\n## Other options\nYou can choose to show only titles available at your local branch, select titles\nfrom another Goodreads shelf, etc. Pass `--help` to see all options:\n\n```\nusage: lookup.py [-h] [--branch BRANCH] [--shelf SHELF] [--biblio BIBLIO]\n                 [--csv CSV]\n                 [user_id] [dev_key]\n\nSee which books you want to read are available at your local library.\n\npositional arguments:\n  user_id          User's ID on Goodreads\n  dev_key          Goodreads developer key. See https://www.goodreads.com/api\n\noptional arguments:\n  -h, --help       show this help message and exit\n  --branch BRANCH  Only show titles available at this branch. e.g. 'Fremont\n                   Branch'\n  --shelf SHELF    Name of the shelf containing desired books\n  --biblio BIBLIO  subdomain of bibliocommons.com (seattle, vpl, etc.)\n  --csv CSV        Output results to a CSV of this name.\n```\n\n## Cloud-based deployment\nThis may also be deployed as Lambda functions in AWS.\nSee the [Bibliophile README][bibliophile-repo] for instructions.\n\n\n[bibliophile-repo]: https://github.com/DavidCain/bibliophile\n[goodreads-api]: https://www.goodreads.com/api\n[goodreads-api-terms]: https://www.goodreads.com/api/terms\n[poetry-install]: https://python-poetry.org/docs/#installation\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdavidcain%2Fbibliophile-backend","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdavidcain%2Fbibliophile-backend","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdavidcain%2Fbibliophile-backend/lists"}