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

Update NYPL DAG to use API v2 #3774

Merged
merged 4 commits into from Feb 16, 2024
Merged

Update NYPL DAG to use API v2 #3774

merged 4 commits into from Feb 16, 2024

Conversation

AetherUnbound
Copy link
Contributor

@AetherUnbound AetherUnbound commented Feb 9, 2024

Fixes

Fixes #2747 by @krysal

Description

This PR updates the NYPL DAG to use the new v2 API. Fortunately almost nothing changed with the actual API interaction details! So this became a very straightforward change. The only major change was putting the tags in the right place!

I also added the option to pass arguments into the catalog's ipython recipe.

Testing Instructions

  1. Get the NYPL API key and add it to AIRFLOW_VAR_API_KEY_NYPL in the .env
  2. Enable the NYPL workflow and let it run for however long you set your AIRFLOW_VAR_INGESTION_LIMIT (note that this DAG is slow and will take about 3 hours to run end-to-end for ~3k results).

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 (if 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.

@openverse-bot openverse-bot added 🟧 priority: high Stalls work on the project or its dependents 🛠 goal: fix Bug fix 💻 aspect: code Concerns the software code in the repository 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work labels Feb 9, 2024
@github-actions github-actions bot added the 🧱 stack: catalog Related to the catalog and Airflow DAGs label Feb 9, 2024
@AetherUnbound AetherUnbound marked this pull request as ready for review February 9, 2024 02:28
@AetherUnbound AetherUnbound requested review from a team as code owners February 9, 2024 02:28
@AetherUnbound AetherUnbound removed the 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work label Feb 9, 2024
@AetherUnbound AetherUnbound removed the request for review from fcoveram February 9, 2024 02:28
@AetherUnbound AetherUnbound changed the title Upgrade NYPL DAG to use API v2 Update NYPL DAG to use API v2 Feb 9, 2024
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.

Awesome that the update only took ~22 lines of code! Tested fine locally.

@openverse-bot
Copy link
Collaborator

Based on the high urgency of this PR, the following reviewers are being gently reminded to review this PR:

@krysal
This reminder is being automatically generated due to the urgency configuration.

Excluding weekend1 days, this PR was ready for review 2 day(s) ago. PRs labelled with high urgency are expected to be reviewed within 2 weekday(s)2.

@AetherUnbound, if this PR is not ready for a review, please draft it to prevent reviewers from getting further unnecessary pings.

Footnotes

  1. Specifically, Saturday and Sunday.

  2. For the purpose of these reminders we treat Monday - Friday as weekdays. Please note that the operation that generates these reminders runs at midnight UTC on Monday - Friday. This means that depending on your timezone, you may be pinged outside of the expected range.

Copy link
Member

@krysal krysal left a comment

Choose a reason for hiding this comment

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

It's nice that it was a simple update!

"type_of_resource": "cartographic",
"physical_description": "4 polyester film encapsulations, some containing 2 sheets back-to-back. "
"Accompanying text formatted as 1 large sheet (46 x 59 cm), in one of "
"the encapsulations.",
},
"raw_tags": ["Census districts"],
Copy link
Member

Choose a reason for hiding this comment

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

Great to send this field to the correct place now!

@AetherUnbound AetherUnbound merged commit 78d799c into main Feb 16, 2024
40 checks passed
@AetherUnbound AetherUnbound deleted the feature/nypl-v2 branch February 16, 2024 04:04
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: fix Bug fix 🟧 priority: high Stalls work on the project or its dependents 🧱 stack: catalog Related to the catalog and Airflow DAGs
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Change NYPL DAG to use the API v2
4 participants