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

Add Collect creator data from Europeana API #5057

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

dryruffian
Copy link
Contributor

@dryruffian dryruffian commented Oct 20, 2024

Fixes

Fixes #2834 by @obulat

Description

Added a New method _get_creator in class EuropeanaRecordBuilder to collect cerator data form dcCreator field, which contains the creator information, is now extracted and included in the record data.

Checklist

  • My pull request has a descriptive title (not a vague title likeUpdate index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.
  • I ran the DAG documentation generator (ov just catalog/generate-docs for catalog
    PRs) or the media properties generator (ov just catalog/generate-docs media-props
    for the catalog or ov just api/generate-docs for the API) where applicable.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@dryruffian dryruffian requested a review from a team as a code owner October 20, 2024 13:04
@dryruffian dryruffian requested review from obulat and stacimc and removed request for a team October 20, 2024 13:04
@openverse-bot openverse-bot added 🧱 stack: catalog Related to the catalog and Airflow DAGs 🟨 priority: medium Not blocking but should be addressed soon ✨ goal: improvement Improvement to an existing user-facing feature 💻 aspect: code Concerns the software code in the repository labels Oct 20, 2024
@dryruffian
Copy link
Contributor Author

Yo @obulat, can you please review this PR? It adds a new method to the EuropeanaRecordBuilder class that collects creator data from the dcCreator field.

Copy link
Contributor

@obulat obulat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This PR is almost there, @dryruffian! There are two points that need to be fixed to make it working correctly.

@@ -68,6 +68,7 @@ def get_record_data(self, data: dict) -> dict | None:
"foreign_identifier": self._get_foreign_identifier(data),
"meta_data": self._get_meta_data_dict(data),
"title": self._get_title(data),
"creator": self._get_creator(item_data),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"creator": self._get_creator(item_data),
"creator": self._get_creator(data),

I tested this PR using October 1st as the date. The dcCreator is available in data dictionary, not item_data.

creators = item_data.get("dcCreator", [])
if not creators:
return None
return creators if isinstance(creators, str) else ", ".join(creators)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's better to check if the creators is an instance of list or not:

if isinstance(creators, list):
    return ", ".join(creators)
elif isinstance(creators, str):
    return creators
return None

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thank's @obulat for the suggestion I have updated the code to check creators is an instance of list or not. I have also added also tests for some edge cases

"item_data, expected",
[
# Single creator in a list
pytest.param({"dcCreator": ["Chandler"]}, "Chandler", id="single_creator"),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😆

@obulat obulat removed the request for review from stacimc October 21, 2024 15:49
@dryruffian dryruffian requested a review from a team as a code owner October 21, 2024 17:36
@dryruffian dryruffian requested review from obulat and stacimc and removed request for a team October 21, 2024 17:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💻 aspect: code Concerns the software code in the repository ✨ goal: improvement Improvement to an existing user-facing feature 🟨 priority: medium Not blocking but should be addressed soon 🧱 stack: catalog Related to the catalog and Airflow DAGs
Projects
Status: 🔁 Changes Requested
Development

Successfully merging this pull request may close these issues.

Europeana script should collect the creator
3 participants