Publish links

[blue442]

Addressing #187 by adding the functionality where foundry.publish_dataset() can take links in the form of a keyword argument. The arguments associated with the links 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 to main, and therefore appears to contain more changes than intended.

[codecov-commenter]

Codecov Report

Merging #390 (fc12b1f) into main (0ccb39b) will decrease coverage by 1.39%. Report is 2 commits behind head on main. The diff coverage is 8.33%.

:exclamation: Current head fc12b1f differs from pull request most recent head b57c1cc. Consider uploading reports for the commit b57c1cc to get more accurate results

:exclamation: 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     

Files Changed	Coverage Δ
foundry/foundry.py	57.41% <8.33%> (-1.98%)	:arrow_down:

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more

[ascourtas]

the publishing example addition looks mostly very good, thank you steve! could you just add what the other options are in the comment above the example links? And in the documentation, it would be good to define the different options (eg "other_paper", etc) more thoroughly.

Also, can you clear the output of this cell and repush the publish example notebook?