splent-feature-curation 0.2.0__py3-none-any.whl

splent_feature_curation-0.2.0.dist-info/METADATA

@@ -0,0 +1,95 @@
+Metadata-Version: 2.4
+Name: splent_feature_curation
+Version: 0.2.0
+Summary: The review queue of a hub: the datasets its policy sends to review before they are published, and the withdrawals their owners ask for
+License-Expression: LGPL-3.0-or-later
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+License-File: COPYING
+License-File: COPYING.LESSER
+Requires-Dist: splent_framework>=1.30.0
+Dynamic: license-file
+
+# splent_feature_curation
+
+The review queue of an OpenHubs hub (GV-2): what a curator looks at before
+the hub acts on it.
+
+- **Publications.** Where dataset's `DATASET_PUBLISH_POLICY` is `curated`,
+  an account curation does not trust sends its dataset to review instead of
+  publishing it. It waits, submitted, and nothing reaches the provider until
+  a curator approves it; it is then published in the background, through
+  the provider its owner chose. A rejection takes it back to a draft its
+  owner changes and sends again, and its owner can take it back from review
+  too. A dataset waiting for review cannot be changed: what is approved is
+  what is published.
+- **Withdrawals.** The owner of a published dataset asks for it to be
+  withdrawn from its page (the button fills dataset's `dataset.view.actions`
+  slot), saying why. A curator withdraws it (its DOI then
+  answers with a tombstone that says why, 451 for a legal reason) or rejects
+  the request, and the dataset stays published.
+- **The queue**, under Administration in the panel, for the accounts whose
+  role is in `CURATION_REVIEWER_ROLES`, with the count of what waits on its
+  menu entry. Every decision carries a note; the owner is mailed it, and the
+  reviewers are mailed when something new waits (with the mail feature).
+
+curation is the reviewer of dataset's policy: it implements dataset's
+`PublicationReviewer` and registers itself from `init_feature` with
+`register_publication_reviewer`, so a product whose policy is `curated`
+installs it, or it does not start. It changes datasets only through
+dataset's services, and keeps the requests and who decided them in its own
+table, `curation_request`. It requires auth and dataset 0.8.0 or later, and
+mails with the mail feature when the product has it.
+
+| Route | |
+|-------|-|
+| `GET /admin/curation` | The queue |
+| `GET /admin/curation/<request_id>` | One request, with the dataset it is about |
+| `POST /admin/curation/<request_id>/approve`, `.../reject` | The curator's decision, with its note |
+| `POST /datasets/<dataset_id>/withdrawal-request` | The owner asks for a withdrawal |
+| `POST /datasets/<dataset_id>/withdrawal-request/cancel` | The owner takes the request back |
+
+## Who is trusted
+
+`CURATION_TRUSTED_ACCOUNTS` says which accounts publish without review on a
+curated hub:
+
+| Value | Trusted |
+|-------|---------|
+| `none` | no account: every publication is reviewed |
+| `published` (default) | an account with a dataset published on the hub |
+| `carried_over` | an account carried over from an older site (auth's `account_origin`) with a dataset published, the history uvlhub 2.12 gave it (D4) |
+
+Whatever the value, a curator is trusted, and an account one of whose
+datasets was withdrawn as spam or malware is not. A trusted account still
+confirms its address first, as dataset's `verified` asks.
+
+## Parameters
+
+All three are typed in `[tool.splent.config_schema]` and of `derivation`
+bind: the product decides them, and an environment that changes them is
+drift.
+
+| Key | Type | Default | |
+|-----|------|---------|-|
+| `CURATION_TRUSTED_ACCOUNTS` | enum: `none`, `published`, `carried_over` | `published` | who publishes without review |
+| `CURATION_REVIEWER_ROLES` | list of `admin`, `staff` | `["admin"]` | the roles of the curators |
+| `CURATION_NOTIFY_REVIEWERS` | bool | `true` | whether the curators are mailed what is new. The owner is mailed every decision either way, with mail |
+
+## In the model
+
+An optional `curation` node of `repositorio` in openhubs_spl, which
+`publish_curated` (the `curated` value of `DATASET_PUBLISH_POLICY`)
+requires: `publish_curated => curation`, so a curated hub without its
+reviewer does not validate. `docs/openhubs_spl.uvl.patch` was the change of
+`splent_spl_openhubs/openhubs_spl.uvl` that added it.
+
+## Develop
+
+```bash
+splent feature:test curation --with dataset
+splent feature:contract splent_feature_curation --write
+```
+
+It needs dataset 0.8.0, the release with the policy: until it is out, its
+tests take dataset's working copy (`--with dataset`).

splent_feature_curation-0.2.0.dist-info/RECORD

@@ -0,0 +1,24 @@
+splent_feature_curation-0.2.0.dist-info/licenses/COPYING,sha256=jOtLnuWt7d5Hsx6XXB2QxzrSe2sWWh3NgMfFRetluQM,35147
+splent_feature_curation-0.2.0.dist-info/licenses/COPYING.LESSER,sha256=2n6rt7r999OuXp8iOqW9we7ORaxWncIbOwN1ILRGR2g,7651
+splent_io/splent_feature_curation/__init__.py,sha256=mGb7XAxruf6bKTtu8olCnxk_A1Af1JQmDqL-nPXzDTQ,2551
+splent_io/splent_feature_curation/config.py,sha256=MO0-ChIwObbUe5izmxo82d7VrO5gSoeqomzZZxDB578,381
+splent_io/splent_feature_curation/hooks.py,sha256=tssl2X9MOlvkiOXc3Z75-VXdCc_CBEL5mP22nmzCyzk,1220
+splent_io/splent_feature_curation/models.py,sha256=5A0eiMdOossHDsQ-ICqU5ohd_7tQ5N6e02bISzBhpGo,4931
+splent_io/splent_feature_curation/repositories.py,sha256=NuQhx5cGKadvs9NPPmuUd3MkQULfdADLVO6cksF3cIw,1644
+splent_io/splent_feature_curation/reviewer.py,sha256=0ItBqbl2hAP9a9Vwe6-3lGysaG64sGVIoTCCQVHBqzs,681
+splent_io/splent_feature_curation/routes.py,sha256=-lsbXdWYodMm4MhpSESqdbshCgOTgGF_duTH_jKMAro,6215
+splent_io/splent_feature_curation/services.py,sha256=hfKuKdVl4kK-_AtyaR0iagtO9VEjGzRX6DeN6dXJxZs,18921
+splent_io/splent_feature_curation/signals.py,sha256=v3hLnzdNMXCVwVWlyDrFE4E-s9Kn2hb5DfFcXLpWsD8,912
+splent_io/splent_feature_curation/migrations/alembic.ini,sha256=WA1biGHSZpXO-M7uFtAZVRSV5Fih0VIQY-Yp7G7xGTk,517
+splent_io/splent_feature_curation/migrations/env.py,sha256=MEZtouwkeVcwr0HLQ-ivVH279U6h4MhdNtI0tkJs4_I,321
+splent_io/splent_feature_curation/migrations/script.py.mako,sha256=8_xgA-gm_OhehnO7CiIijWgnm00ZlszEHtIHrAYFJl0,494
+splent_io/splent_feature_curation/migrations/versions/curation0001_requests.py,sha256=ChTgL1-sgNIAG-e3odG4uE8PNeEk2SPCBwV-304Oxdk,2764
+splent_io/splent_feature_curation/templates/curation/admin/_dataset_link.html,sha256=furyOtHdrdjFqySI6pTmS2q7y7YBBnVHyg29CVnAQUY,476
+splent_io/splent_feature_curation/templates/curation/admin/_flashes.html,sha256=bsc4gsQf1OiIW7QMeS2bCg92hCFAwxA4gpeB3x5SXp4,252
+splent_io/splent_feature_curation/templates/curation/admin/queue.html,sha256=CckPIHsJsIYqx0ehmh5ZNTNiE3fVtT_M8jdp_2nrDOM,3720
+splent_io/splent_feature_curation/templates/curation/admin/request.html,sha256=50dcWhqxVh7Q-6ht2ckgaZUJa8ZFofqeErnOG6_8VtQ,6324
+splent_io/splent_feature_curation/templates/hooks/withdrawal_request.html,sha256=FjB_ePdv3ER_kYXBuAc4fqLkLLAPR_dfprBprx0Jb2o,3113
+splent_feature_curation-0.2.0.dist-info/METADATA,sha256=0b4PEQUYojrSdcIR8z1n18tZbURSsr8epSQiKqn7NXc,4479
+splent_feature_curation-0.2.0.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+splent_feature_curation-0.2.0.dist-info/top_level.txt,sha256=nksrfdr_edPhGPUsCqz08kyNRLBkNc2sInZYzmbZ4TA,10
+splent_feature_curation-0.2.0.dist-info/RECORD,,

splent_feature_curation-0.2.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.2.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+