Skip to main content

CKAN License

ckanext-zenodo

Publishes large or non-tabular dataset files to Zenodo (sandbox during development, production later) instead of CKAN storage, mapping the dataset's FDF metadata into the Zenodo deposition. The CKAN dataset stays published in the FAIR3R catalogue (full FDF metadata, searchable) with a link to the Zenodo DOI for the actual data, instead of carrying the file itself.

Status

Work in progress, built in staged merge requests. See the implementation plan for the full design (file flow, data model, metadata mapping, anti-abuse hardening, staged delivery order) - ask in the project chat for the current plan reference if you don't have it to hand.

Routing rule (once implemented): a file goes to Zenodo instead of CKAN storage when it's larger than ckan.max_resource_size, or its format isn't one ckanext.xloader.formats can read - or whenever the user explicitly asks for Zenodo regardless of size/format.

Relationship to ckanext-fair3r

Not a declared package dependency (not in pyproject.toml), but FAIR3R is this plugin's reason to exist, at two different levels:

  • Soft Python dependency - lib/publish_guard.py imports ckanext.fair3r.lib.fdf.datacite_converter.DataCiteConverter inside a try/except ImportError to map a dataset's FDF metadata into the Zenodo deposition's description/creators/keywords/etc. Same pattern ckanext-citations' helpers.py already uses for completeness_for_package. Without ckanext-fair3r installed (or on a dataset with no fdf_output_json extra), a deposition still gets published - just with minimal metadata (title and the submitting user's name only), never a hard failure.
  • Operational dependency, not a code one - the actual trigger for uploading to this plugin's /zenodo/upload/<package> endpoint lives entirely in ckanext-fair3r's own resource-upload.js (the size/format routing decision and the "force Zenodo" checkbox). Without ckanext-fair3r installed and enabled, nothing in the normal CKAN UI ever calls this plugin's upload endpoint at all - it would need a hand-crafted request. See the implementation plan's staged delivery order for exactly where that wiring lands.

In short: install this plugin on its own and it runs (migrations apply, the blueprint responds, tests pass), but it's only actually useful alongside a FAIR3R deployment that also runs ckanext-fair3r.

Sandbox smoke test findings (Stage 8)

Confirmed empirically against the real sandbox.zenodo.org (the current, InvenioRDM-based Zenodo) - two things the implementation plan flagged as unverified assumptions, now settled:

  • metadata.creators is required to publish, even though updating a deposition's metadata without it is accepted - omitting it makes publish_deposition fail every time with a 400. metadata_mapper.py's datacite_to_zenodo now always sets creators, falling back to the submitter's name when the DataCite metadata has none (e.g. no ckanext-fair3r, or no FDF metadata yet).
  • Setting metadata.communities does not associate the record with that community by itself - it only opens a pending community-inclusion request against the record, which stays unaccepted (and invisible under the community) until explicitly accepted, even for the account that owns the community. publish_guard.py now does this automatically right after a successful publish (_accept_pending_community_inclusion) - best-effort: a failure here is logged but never undoes the publish (the DOI is already minted by that point).
  • The description HTML sanitizer runs on write, not just on display, and its real allow-list is now documented directly above build_zenodo_description_html in metadata_mapper.py (confirmed by round-tripping a probe deposition through every plausible tag and reading back what Zenodo actually stored).

Tests

docker exec -u ckan -it ckan-app pytest --ckan-ini=/plugins/ckanext-zenodo/test.ini /plugins/ckanext-zenodo/ckanext/zenodo/tests

License

Released under the GNU Affero General Public License (AGPL) v3.0. See the file LICENSE for details.

Metadata

Release files for ckanext-zenodo 0.1.11

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ckanext-zenodo 0.1.11
File Size Uploaded Provenance
ckanext_zenodo-0.1.11.tar.gz 47.2 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for ckanext-zenodo 0.1.11
File Interpreter ABI Platform
ckanext_zenodo-0.1.11-py3-none-any.whl Python 3 none any Details

Total release size: 101.8 kB

Release files / ckanext_zenodo-0.1.11.tar.gz

Download URL ckanext_zenodo-0.1.11.tar.gz
Size 47.2 kB
Tags Source
SHA-256 checksum
How to use checksums
097501ecd1350cb501f7e06e3908f10449efdae00194ddfae9aaaf6227a87c0b
BLAKE2b-256 checksum
How to use checksums
da617393d8c107c700363c7004745a2943b0b4ecd20b75a30368c3ab9551cd73
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.10.22

Release files / ckanext_zenodo-0.1.11-py3-none-any.whl

Download URL ckanext_zenodo-0.1.11-py3-none-any.whl
Size 54.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3008f7111ffd52f59e26be1fca18b707a12689c93920bb9e5db825dd75a58ef7
BLAKE2b-256 checksum
How to use checksums
62d99ebc70ebdeb2cdc3ffb6e2938e06266a7750bd7e7b8a714a848a8c7cbe24
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.10.22

Security for ckanext-zenodo 0.1.11

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page