Repository navigation
ENH: Add CITATION.cff and prepare Zenodo integration - #1494
Conversation
for more information, see https://pre-commit.ci
…grawal/openml-python into fix/1210-auth-warning
for more information, see https://pre-commit.ci
|
@PGijsbers This PR is ready for review! It includes the Once this is merged, a repository admin will just need to enable the repository in the Zenodo settings to start archiving future releases. |
- Implements edit_flow function to edit custom_name, tags, language, and description fields - Follows the same pattern as edit_dataset function - Adds comprehensive tests for the new functionality - Updates __init__.py to expose the new function in the public API - Addresses issue openml#896: Edit (some) fields of flow after upload The function allows flow owners to edit non-critical metadata fields while preserving flow integrity and preventing unauthorized edits.
for more information, see https://pre-commit.ci
PGijsbers
left a comment
PGijsbers
left a comment
There was a problem hiding this comment.
Some questions about the changes to the cff file.
Please also remove the changes to flows and tests from this PR as these changes are unrelated to Zenodo integration.
|
@PGijsbers Thanks for the review! I have updated the PR based on your feedback:
Ready for re-review! |
PGijsbers
left a comment
PGijsbers
left a comment
There was a problem hiding this comment.
Thank you! I changed the software authors to a simple collective name for now. I set the necessary permissions on Zenodo.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1494 +/- ##
=======================================
Coverage 53.68% 53.68%
=======================================
Files 63 63
Lines 5251 5251
=======================================
Hits 2819 2819
Misses 2432 2432 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Reference Issue: Fixes #1334
New Tests Added: NA
Documentation Updated: Yes
Change Log Entry: Add CITATION.cff and Zenodo release documentation
Details
Description
This PR prepares the repository for Zenodo integration as discussed in issue #1334.
Changes
Added CITATION.cff: Configured to use the JMLR 2021 paper (Feurer et al.) as the preferred-citation. This ensures users citing the software are directed to the correct academic publication, rather than just the source code.
Updated README: Added a placeholder for the Zenodo DOI badge in the header.
Updated Documentation: Added a note in CONTRIBUTING.md (Appendix) regarding the Zenodo release workflow to guide future maintainers.