-
Notifications
You must be signed in to change notification settings - Fork 16
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
Publish links #390
base: main-bak
Are you sure you want to change the base?
Publish links #390
Conversation
Codecov Report
❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more. @@ Coverage Diff @@
## main #390 +/- ##
==========================================
- Coverage 72.08% 70.70% -1.39%
==========================================
Files 9 9
Lines 541 553 +12
==========================================
+ Hits 390 391 +1
- Misses 151 162 +11
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great! All that's left to finalize this is updates in the GitBook documentation and in the example notebooks (under /examples
). Let me know if you're having trouble with the GitBook documentation -- you can open an Edit Request which is like a PR there
Addressing #187 by adding the functionality where
foundry.publish_dataset()
can take links in the form of a keyword argument. The arguments associated with thelinks
keyword are of the following form:{"type":str, "doi":str, "url":str, "description":str, "bibtex":str}
following the convention laid out in the MDF data schemas, and can be included as a single argument or a list of arguments.
Some light validation is performed to ensure that the keys in each of the link conform to the options described in the MDF schema (but are all optional); violation results in a
ValueError
being thrown.After validation the links are passed to the
add_links()
function from the MDF connect client.Tests were included in
test_foundry.py
to test the successful addition of links as well as ensuring the validation process works successfully.NOTE: This branch was based off of the
reviving_load
branch which is yet to be merged tomain
, and therefore appears to contain more changes than intended.