feat: OpenLibrary SearchSource

[geritwagner]

Description

Extend the colrev.open_library package by implementing searches of the OpenLibrary API.

Implementation Notes

• Update the OpenLibrary SearchSource to include the search method, allowing users to search for books using various parameters such as titles, authors, and ISBNs. This method should be capable of handling complex queries, ensuring accurate and relevant search results from the OpenLibrary database.
• Documentation should guide users on how to perform searches and load search results.
• Implement unit tests simulating the retrieval process with a simple example. The colrev.crossref package provides an example for unit tests.
• The packages docs page explains the steps of developing CoLRev packages.
• The search-feed offers functionality for storing records.
• CEP003 describes principles for SearchSources.
• CEP002 describes the standard data schema for records.
• The colrev.crossref package implements similar unit tests.

User Story

1. The user initializes a CoLRev project using colrev init.
2. He/she conducts a search operation with colrev search -a colrev.open_library, specifying search parameters relevant to their topic.
3. The package retrieves records based on the parameters and saves them in the data/search directory of the project.
4. When users run colrev load, the records from the search directory are added to the data/records.bib file, which integrates all search results in the project.
5. When users run colrev search again, records are retrieved from the API, updating the existing records.

Useful Links

• OpenLibrary API Search Documentation - To guide the implementation of the search operation.

Expected Effort

2 months, 3-4 people.

[CelinaSchwarz]

I would like to contribute to that issue as my second choice

[QuynhMaiNguyen]

I would like to contribute to that issue as my second choice

[Bakuu97]

I would like to contribute to this issue

[k-schnickmann]

I want to contribute to this issue (second choice).

[ArdaTasdelen]

I would like to contribute to this issue

[ciremcelen]

I would like to contribute to this issue (first choice).

[geritwagner]

This looks like a group of three: @Bakuu97 , @ArdaTasdelen and @ciremcelen :+1: Can you select a group lead, fork the repository and link your repository in this feed?

[Bakuu97]

Hi, here link https://github.com/Bakuu97/colrevGroup241

---

Von: Gerit Wagner @.> Gesendet: Montag, 29. April 2024 12:45 An: CoLRev-Environment/colrev @.> Cc: Murad Zeynalli @.>; Mention @.> Betreff: Re: [CoLRev-Environment/colrev] feat: OpenLibrary SearchSource (Issue #241)

This looks like a group of three: @Bakuu97https://github.com/Bakuu97 , @ArdaTasdelenhttps://github.com/ArdaTasdelen and @ciremcelenhttps://github.com/ciremcelen 👍 Can you select a group lead, fork the repository and link your repository in this feed?

— Reply to this email directly, view it on GitHubhttps://github.com/CoLRev-Environment/colrev/issues/241#issuecomment-2082401741, or unsubscribehttps://github.com/notifications/unsubscribe-auth/BIDGJNDLUYCQREQ3F3D7ZWTY7YQDXAVCNFSM6AAAAAA446A6TGVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDAOBSGQYDCNZUGE. You are receiving this because you were mentioned.Message ID: @.***>