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

Command-line datadoc script #281

Merged
merged 80 commits into from
Jan 6, 2025
Merged

Command-line datadoc script #281

merged 80 commits into from
Jan 6, 2025

Conversation

jesper-friis
Copy link
Contributor

@jesper-friis jesper-friis commented Jan 3, 2025

Description

Added a new command-line tool for data documentation and documented it.

Type of change

  • Bug fix and code cleanup
  • New feature
  • Documentation update
  • Testing

Checklist for the reviewer

This checklist should be used as a help for the reviewer.

  • Is the change limited to one issue?
  • Does this PR close the issue?
  • Is the code easy to read and understand?
  • Do all new feature have an accompanying new test?
  • Has the documentation been updated as necessary?
  • Is the code properly tested?

jesper-friis and others added 30 commits December 15, 2024 19:18
  - Allow to add other types of entries to the triplestore that are not
    datasets. Ex: samples, models, instruments, people, projects...
  - Renamed list_data_iris() to search_iris(). It can now be use to search
    for all types of entries.
  - Renamed prepare() to as_jsonld() and made it part of the public API
Co-authored-by: Tor S. Haugland <torshaugland@gmail.com>
Co-authored-by: Tor S. Haugland <torshaugland@gmail.com>
Copy link

codecov bot commented Jan 3, 2025

Codecov Report

Attention: Patch coverage is 46.51163% with 92 lines in your changes missing coverage. Please review.

Project coverage is 76.68%. Comparing base (5e92f3b) to head (54523e2).
Report is 1 commits behind head on master.

Files with missing lines Patch % Lines
tripper/dataset/datadoc.py 12.00% 88 Missing ⚠️
tripper/dataset/dataaccess.py 0.00% 2 Missing ⚠️
tripper/dataset/dataset.py 92.59% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master     #281      +/-   ##
==========================================
- Coverage   79.18%   76.68%   -2.50%     
==========================================
  Files          21       22       +1     
  Lines        2263     2415     +152     
==========================================
+ Hits         1792     1852      +60     
- Misses        471      563      +92     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Base automatically changed from dataset-docs to master January 3, 2025 23:09
@jesper-friis jesper-friis mentioned this pull request Jan 4, 2025
24 tasks
@jesper-friis jesper-friis requested a review from torhaugl January 6, 2025 08:27
Copy link
Contributor

@torhaugl torhaugl left a comment

Choose a reason for hiding this comment

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

Some minor comments.

I find the way of calling the CLI here to be a bit unconventional.

For instance, to find something, I have to parse before running find:

datadoc --parse="kb.ttl" find

Should we instead have

datadoc find --parse="kb.ttl"

The parse keyboard could also be set as required/positional for datadoc find I think.

docs/dataset/customisation.md Outdated Show resolved Hide resolved
],

# Documenting of the resource using keywords defined in the context
...
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
...
# ...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is documentation that is not checked with doctext, so I think it is fine to keep the ellipsis. Changing from json to python removes the strict syntax checking on github

Co-authored-by: Tor S. Haugland <torshaugland@gmail.com>
@jesper-friis jesper-friis merged commit 33a0acf into master Jan 6, 2025
19 of 21 checks passed
@jesper-friis jesper-friis deleted the datadoc branch January 6, 2025 13:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants