Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cover Service Improvements #6822

Open
3 of 7 tasks
mekarpeles opened this issue Aug 2, 2022 · 1 comment
Open
3 of 7 tasks

Cover Service Improvements #6822

mekarpeles opened this issue Aug 2, 2022 · 1 comment
Labels
Lead: @mekarpeles Issues overseen by Mek (Staff: Program Lead) [managed] Module: Cover Service Cover Store (book covers service) Needs: Detail Submitter needs to provide more detail for this issue to be assessed (see comments). [managed] Priority: 2 Important, as time permits. [managed] Type: Epic A feature or refactor that is big enough to require subissues. [managed] Type: Feature Request Issue describes a feature or enhancement we'd like to implement. [managed]

Comments

@mekarpeles
Copy link
Member

mekarpeles commented Aug 2, 2022

Tasks

See 2023 yearly planning notes:

Bonus opportunities

  • Create monthly dumps which map a cover ID to isbn/lccn/olid -> access url; e.g. archive.org zip offset
  • Add author cover urls to solr via Librarian-Verified Authors #7659

@cclauss's Notes

Describe the problem that you'd like solved

  • What documentation do we have about book cover images?
  • What book cover image cron jobs do we currently run?
  • Are we properly backing up the book cover images that we get from affiliates?
  • Can we restore our book cover images from those backups?
  • Do we provide our clients a covers API?
  • If we have an API for accessing book cover images, how often is it used?
  • If we have an API for accessing book cover images, how could it be improved?

ol-covers on Sentry

Proposal & Constraints

Pull request #6706 -- Add book cover images from Better World Book imports
Steps:

  1. Create a dictionary of all book cover images that have been imported from Better World Books so far this year.
  2. Create a dictionary of all Open Library ISBNs in the previous dictionary that do not have a book cover image.
  3. Enhance the Open Library record of all ISBNs that appear in the second dictionary to add the image to the OL record.

Additional context

Stakeholders


Initial timeline:

2022-08-30 Present the draft roadmap on a community call to solicit feedback.
2022-09-15 Send out a survey of needs and ideas to Librarians, Developers, Operations
2022-09-30 Release final roadmap and present on a community call

Open Library: Roadmap for Book Cover Images

Summary

Workstreams: Covers acquisition, storage, retrieval, and documentation

How do we get cover images?

Open Library obtains book cover images via the covers service which is a cron job that runs in a dedicated Docker container.

How do we store cover images?

Book cover images via the covers service are stored in ol-home0's /1/var/tmp/imports directory in YYYY-MM.zip files. Each file is named isbn_13.jpg (e.g.: 9780425030134.jpg)

How do we provide access to cover images?

The work on #6706 has made it clear that a low-level API that rapidly retrieves cover images based on isbn_13s would:

  1. simplify the creation of advanced search on above, and
  2. simplify integration into other systems.
@mekarpeles mekarpeles added Type: Feature Request Issue describes a feature or enhancement we'd like to implement. [managed] Module: Cover Service Cover Store (book covers service) Needs: Detail Submitter needs to provide more detail for this issue to be assessed (see comments). [managed] Priority: 2 Important, as time permits. [managed] Lead: @cclauss Issues overseen by Chris (Python3 & Dev-ops lead 2019-2021) [managed] labels Aug 2, 2022
@mekarpeles mekarpeles added this to the Active Sprint milestone Aug 2, 2022
@cclauss
Copy link
Contributor

cclauss commented Aug 25, 2022

ISBN, Move off /1, easy bulk access, Handle redactions (take down request).

@mekarpeles mekarpeles added the Type: Epic A feature or refactor that is big enough to require subissues. [managed] label Dec 6, 2022
@mekarpeles mekarpeles changed the title Create Roadmap for Cover Service improvements Roadmap for Cover Service improvements Dec 6, 2022
@mekarpeles mekarpeles added Lead: @mekarpeles Issues overseen by Mek (Staff: Program Lead) [managed] and removed Lead: @cclauss Issues overseen by Chris (Python3 & Dev-ops lead 2019-2021) [managed] labels Mar 20, 2023
@mekarpeles mekarpeles changed the title Roadmap for Cover Service improvements Cover Service Improvements Mar 20, 2023
@mekarpeles mekarpeles modified the milestones: Next (proposed), 2023 Mar 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Lead: @mekarpeles Issues overseen by Mek (Staff: Program Lead) [managed] Module: Cover Service Cover Store (book covers service) Needs: Detail Submitter needs to provide more detail for this issue to be assessed (see comments). [managed] Priority: 2 Important, as time permits. [managed] Type: Epic A feature or refactor that is big enough to require subissues. [managed] Type: Feature Request Issue describes a feature or enhancement we'd like to implement. [managed]
Projects
None yet
Development

No branches or pull requests

2 participants