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: implement new SearchSources #120

Closed
geritwagner opened this issue Feb 6, 2023 · 14 comments · Fixed by #201 or #203
Closed

feat: implement new SearchSources #120

geritwagner opened this issue Feb 6, 2023 · 14 comments · Fixed by #201 or #203
Assignees
Labels
enhancement New feature or request good first issue Good for newcomers
Milestone

Comments

@geritwagner
Copy link
Collaborator

geritwagner commented Feb 6, 2023

Feature Request

Describe the Feature Request

Additional SearchSources should be implemented (see #106 for an overview).

Describe Preferred Solution

The ERIC database would be a good starting point because it is similar to the Crossref API, which is already supported (see crossref SearchSource). In fact, the code skeleton for the ERIC SearchSource already exists. To support API-based searches, the run_search(...) method needs to be implemented (parsing the json response from ERIC). To add a new ERIC-API-based search (and the search parameters), the add_endpoint method needs to be extended.

The arXiv API provides a different format (xml). The code for the pubmed SearchSource provides a good starting point for parsing xml content.

The IEEXplore database is a more challenging example because it requires a registration (an API key). You need to apply for it before you can access the API. The implementation of run_search(...) in the corresponding code skeleton is similar to the ERIC case. The only difference is that the API key must be stored in a local settings file (as a secret). To create a local settings file, code for the project settings (especially the load_settings() and save_settings()) would be useful. The settings should be handled by the environment_manager and available through the review_manager.

Expected Effort Required

2 months, 5 people.

@geritwagner geritwagner added enhancement New feature or request good first issue Good for newcomers labels Feb 6, 2023
@geritwagner geritwagner added this to the v0.10.0 milestone Feb 24, 2023
@Cohen2000
Copy link
Contributor

Hi, Ich hätte Lust dieses Issue zu bearbeiten :)

@MalouSchmidt
Copy link
Contributor

Ich bin dabei!

@RheaDoesStuff
Copy link

Ich wäre auch daran interessiert an diesem Issue mitzuarbeiten :)

@AntonFrisch
Copy link
Contributor

Hallo, ich wäre auch an dem Thema interessiert.

@frxdericz
Copy link
Contributor

Ich auch🤚

@geritwagner
Copy link
Collaborator Author

@frxdericz: die Nachmeldung ist ausnahmsweise ok, da die Gruppe noch nicht voll war.

@RheaDoesStuff
Copy link

Hallo ihr Lieben,

hat für den Milestone schon ein Treffen stattgefunden?
Falls nicht, wollen wir uns vielleicht mal zusammen setzen? :)

@Cohen2000
Copy link
Contributor

Hallo ihr Lieben,

hat für den Milestone schon ein Treffen stattgefunden? Falls nicht, wollen wir uns vielleicht mal zusammen setzen? :)

Hi,
Wir sind bis jetzt eine 3er Gruppe und haben auch schon eine WhatsApp Gruppe. Du kannst mir gerne hier oder unter '[email protected]' deine Handynummer schreiben, dann kann ich dich hinzufügen :)

@Janus678
Copy link
Contributor

@Cohen2000
Hallo zusammen,
wie seid ihr in der Gruppe :)
Kann ich noch anschließen ?

@Cohen2000
Copy link
Contributor

@Cohen2000 Hallo zusammen, wie seid ihr in der Gruppe :) Kann ich noch anschließen ?

Hi, stand jetzt sind wir zu viert, heißt wir haben noch einen Platz frei. Du kannst mir auch gerne unter '[email protected]' deine Handynummer schreiben, dann kann ich dich noch hinzufügen :)

@Janus678
Copy link
Contributor

@Cohen2000 vielen Dank :) habe dir gerade ne Mail geschrieben!

@geritwagner
Copy link
Collaborator Author

FYI: #187 recently introduced changes relevant to the local settings.

@geritwagner
Copy link
Collaborator Author

A quick update on ERIC: there is a publicationtype field that could be used to set the ENTRYTYPE.

@Janus678
Copy link
Contributor

@geritwagner können sich bitte nochmal assignen :) ich hatte mich gerade vertippt
Vielen Dank. ☺️

This was linked to pull requests Jul 10, 2023
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
Projects
None yet
Development

Successfully merging a pull request may close this issue.

7 participants