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

feat: OpenLibrary SearchSource #241

Open
geritwagner opened this issue Sep 18, 2023 · 8 comments
Open

feat: OpenLibrary SearchSource #241

geritwagner opened this issue Sep 18, 2023 · 8 comments
Labels
enhancement New feature or request good first issue Good for newcomers search_source Updates, fixes, and additions of SearchSources
Milestone

Comments

@geritwagner
Copy link
Collaborator

geritwagner commented Sep 18, 2023

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

Expected Effort

2 months, 3-4 people.

@geritwagner geritwagner added enhancement New feature or request good first issue Good for newcomers labels Sep 18, 2023
@geritwagner geritwagner added this to the v0.11.0 milestone Sep 20, 2023
@geritwagner geritwagner modified the milestones: v0.11.0, v0.12.0 Oct 2, 2023
@geritwagner geritwagner added the search_source Updates, fixes, and additions of SearchSources label Oct 29, 2023
@geritwagner geritwagner removed this from the v0.12.0 milestone Dec 18, 2023
@geritwagner geritwagner changed the title feat: OpenLibrary and OSF SearchSources feat: OpenLibrary SearchSource Feb 22, 2024
@geritwagner geritwagner added this to the v0.13.0 milestone Mar 20, 2024
@CelinaSchwarz
Copy link
Contributor

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

1 similar comment
@QuynhMaiNguyen
Copy link
Contributor

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

@Bakuu97
Copy link

Bakuu97 commented Apr 28, 2024

I would like to contribute to this issue

@k-schnickmann
Copy link
Contributor

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

@ArdaTasdelen
Copy link

I would like to contribute to this issue

@ciremcelen
Copy link

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

@geritwagner
Copy link
Collaborator Author

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

@Bakuu97
Copy link

Bakuu97 commented Apr 30, 2024 via email

@geritwagner geritwagner removed this from the v0.13.0 milestone Jun 17, 2024
@geritwagner geritwagner added this to the SearchSources milestone Sep 14, 2024
@geritwagner geritwagner modified the milestones: SearchSources, v0.14.0 Oct 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers search_source Updates, fixes, and additions of SearchSources
Projects
None yet
Development

No branches or pull requests

7 participants