-
Notifications
You must be signed in to change notification settings - Fork 54
feat: OpenLibrary SearchSource #241
Copy link
Copy link
Open
Labels
enhancementNew feature or requestNew feature or requestgood first issueGood for newcomersGood for newcomerssearch_sourceUpdates, fixes, and additions of SearchSourcesUpdates, fixes, and additions of SearchSources
Milestone
Description
Description
Extend the colrev.open_library package by implementing searches of the OpenLibrary API.
Implementation Notes
- Update the OpenLibrary SearchSource to include the
searchmethod, 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
- The user initializes a CoLRev project using
colrev init. - He/she conducts a search operation with
colrev search -a colrev.open_library, specifying search parameters relevant to their topic. - The package retrieves records based on the parameters and saves them in the
data/searchdirectory of the project. - When users run
colrev load, the records from the search directory are added to thedata/records.bibfile, which integrates all search results in the project. - When users run
colrev searchagain, 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.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
enhancementNew feature or requestNew feature or requestgood first issueGood for newcomersGood for newcomerssearch_sourceUpdates, fixes, and additions of SearchSourcesUpdates, fixes, and additions of SearchSources