About
Datasets: metadata, authors, versions, DOI landing pages (with FAIR metadata), BibTeX, QR and downloads. Their files come from hubfile, stacked on top
Provides
AuthorDOIMappingDSDownloadRecordDSMetaDataDSMetricsDSViewRecordDataSetIdempotencyKeyOrcidCheck
AuthorServiceDOIMappingServiceDSDownloadRecordServiceDSMetaDataServiceDSViewRecordServiceDataSetServiceDatasetAccessPolicyDatasetCommandsLineageService
/datasets/<int:dataset_id>/authorship-claim/datasets/<int:dataset_id>/draft//datasets/download/<int:dataset_id>/datasets/download/all/datasets/list/datasets/providers/<string:name>/health/datasets/unsynchronized/<int:dataset_id>//doi/<path:doi>/doi/<path:doi>//profile/summary/records/<string:pid>/records/<string:pid>/
explore.asidehome.sectionlayout.head.csslayout.navbar.itemslayout.scripts
dataset-credits-changeddataset-deleteddataset-downloadeddataset-hidden-changeddataset-publisheddataset-submission-cancelleddataset-submitteddataset-updateddataset-vieweddataset-withdrawn
es
Commands
-
$
splent feature:dataset dumpBring the ZIP of every public dataset in step now: append what is
-
$
splent feature:dataset publication-reconcile [OPTIONS]Settle the publications that did not end, and list what is left.
-
$
splent feature:dataset purge DATASET_ID [OPTIONS]Take away the files of a withdrawn dataset, keeping its tombstone.
-
$
splent feature:dataset withdraw DATASET_ID [OPTIONS]Withdraw a published dataset: its DOI answers with a tombstone.
Run them in your workspace once the feature is installed in the selected product.
Configuration
| Setting | Default | What it does |
|---|---|---|
DATASET_PUBLISHER_NAME |
empty | Who publishes the datasets: the publisher, provider and data catalog their FAIR metadata names (schema.org, Dublin Core, DataCite, Turtle), and the site the mails and messages about them name. Empty uses SITE_NAME, and without one the host name of DATASET_CATALOG_URL. |
DATASET_CATALOG_URL |
empty | Address of that catalog, the publisher's url in the metadata. Empty uses the site's own external address: the one the request reached, or PREFERRED_URL_SCHEME and SERVER_NAME outside a request. |
DATASET_QR_LOGO |
empty | An image in the product's static folder drawn in the middle of the PNG and JPG QR codes, for example "media/logos/logo.png". Empty draws none. |
DATASET_CREATE_IN_BACKGROUND_FROM |
300
|
No description yet. |
DATASET_LICENSE |
CC-BY-4.0
|
The license every dataset is published under, as an SPDX identifier: what its FAIR metadata, its landing page and its deposit name. |
DATASET_HOME_ORDER |
newest
|
Which datasets the home page puts first: the newest, those that hold the most items (uvl's UVL models), or the best rated, which takes rating. |
DATASET_PUBLICATION_PROVIDER |
empty | The provider a publication goes through when the request names none and the product installs several (zenodo, local_publication). Empty: the only one installed. |
DATASET_PUBLISH_WAIT |
100
|
Seconds a request that publishes (the web's publish step, API v1's publish and new-version) waits for the record before it answers that the publication is still under way: 503 publication_pending in v1, 202 on the web; the publication goes on in the background. Keep it under the worker's timeout (GUNICORN_TIMEOUT) and the proxy's (NGINX_LONG_REQUEST_TIMEOUT). API v1 answers 202 at once to a request with Prefer: respond-async. |
DATASET_PUBLISH_MAX_IN_FLIGHT |
3
|
Publications of one account under way at once; one more is answered 429. 0 for no limit. |
DATASET_DEPOSIT_CONTENT |
sources
|
What a deposit carries: "sources", the dataset's files, or "sources_and_derived", the files and what is derived from them (uvl's Glencoe, DIMACS and SPLOT), waiting for what is still being made at most DATASET_PUBLISH_WAIT seconds. |
DATASET_PUBLISH_POLICY |
open
|
Who publishes (PB-8, D4). "open": any owner, as before; the web asks an account carried over from an older site to confirm its address first. "verified": an owner whose address is confirmed, on the web and in API v1. "curated": as verified, and an owner the reviewer does not trust sends the dataset to review instead, published once a reviewer approves it; it needs a reviewer (splent_feature_curation), or the product does not start. |
DATASET_PUBLISH_PAUSED |
false
|
Every publication held, whatever the policy: the cutover of a hub to a new version. The web sends what it is asked to publish to review, when there is a reviewer; API v1's publish and new-version answer 423 publication_paused, with Retry-After, and change nothing. |
DATASET_PUBLISH_PAUSED_RETRY_AFTER |
3600
|
The seconds that Retry-After says while publication is paused. |
DATASET_DESCRIPTION_ALLOWED_TAGS |
p,br,hr,h4,h5,h6,blockquote,pre,ul,ol,li,table,thead,tbody,tr,th,td,a,strong,em,b,i,u,s,del,code
|
The elements a description keeps (D21, DS-1), whether it is Markdown or the HTML of uvlhub 2.12: what its editor wrote and what Markdown writes for prose, no image. A product names others among the safe ones (the schema's choices); everything else goes, and a script or a style with its content. |
DATASET_ORCID_CHECK_URL |
https://pub.orcid.org/v3.0
|
orcid.org's public API: whether an ORCID iD a dataset credits exists is asked there once the credit is saved, in the background, and the edit form warns about one it does not know; a credit is never refused for it (DL-5). Empty asks nothing, for a deployment that cannot reach it. |
These are the defaults. A product changes them in its own pyproject.toml, under [tool.splent.config], or in .env.deploy in production.
Dependencies
dataset-deleteddataset-hidden-changeddataset-publisheddataset-rateddataset-updateddataset-withdrawnuser-deleting
In product lines
-
openhubs_spl
In every product
Needs
auth
Extension points
dataset.files.nounsdataset.form.scriptsdataset.form.uploaddataset.home.actionsdataset.view.actionsdataset.view.headdataset.view.metadataset.view.primary_actionsdataset.view.scriptsdataset.view.sectionsdataset.view.workbench
dataset/authorship_claim.htmldataset/create_and_edit_dataset.htmldataset/list_datasets.htmldataset/tombstone.htmldataset/view_dataset.htmlhooks/dataset_layout_scripts.htmlhooks/explore_download_all.htmlhooks/home_datasets.htmlhooks/navbar_download_all.html
AuthorServiceDOIMappingServiceDSDownloadRecordServiceDSMetaDataServiceDSViewRecordServiceDataSetServiceDatasetAccessPolicyDatasetCommandsLineageService
AuthorDOIMappingDSDownloadRecordDSMetaDataDSMetricsDSViewRecordDataSetIdempotencyKeyOrcidCheck
Other features fill its hook slots. A refinement can override its templates and services or extend its models without forking it.
Compatibility
>=3.13
>=1.30.0
qrcode==7.4.2markdown-it-py[linkify]>=3.0nh3>=0.3