ckanext-metadata-assistant 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (115) hide show
  1. ckanext_metadata_assistant-0.1.0/AI_ASSISTANCE.md +14 -0
  2. ckanext_metadata_assistant-0.1.0/CHANGELOG.md +39 -0
  3. ckanext_metadata_assistant-0.1.0/CONTRIBUTING.md +35 -0
  4. ckanext_metadata_assistant-0.1.0/LICENSE +21 -0
  5. ckanext_metadata_assistant-0.1.0/MANIFEST.in +10 -0
  6. ckanext_metadata_assistant-0.1.0/PKG-INFO +740 -0
  7. ckanext_metadata_assistant-0.1.0/README.md +700 -0
  8. ckanext_metadata_assistant-0.1.0/SECURITY.md +31 -0
  9. ckanext_metadata_assistant-0.1.0/TROUBLESHOOTING.md +85 -0
  10. ckanext_metadata_assistant-0.1.0/babel.cfg +4 -0
  11. ckanext_metadata_assistant-0.1.0/babel_ckan_tag_shims.py +53 -0
  12. ckanext_metadata_assistant-0.1.0/ckanext/__init__.py +9 -0
  13. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/__init__.py +0 -0
  14. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/actions.py +681 -0
  15. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/admin_settings.py +205 -0
  16. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/ai.py +48 -0
  17. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/assets/.gitkeep +0 -0
  18. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/assets/css/review.css +188 -0
  19. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/assets/js/review.js +2339 -0
  20. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/assets/vendor/codemirror/LICENSE +21 -0
  21. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/assets/vendor/codemirror/README.md +16 -0
  22. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/assets/vendor/codemirror/codemirror.css +344 -0
  23. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/assets/vendor/codemirror/codemirror.min.js +24 -0
  24. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/assets/vendor/codemirror/mark-selection.js +119 -0
  25. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/assets/webassets.yml +12 -0
  26. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/auth.py +5 -0
  27. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/cache.py +123 -0
  28. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/checks.py +200 -0
  29. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/cli.py +203 -0
  30. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/config_declaration.yaml +45 -0
  31. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/examples/__init__.py +0 -0
  32. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/examples/multilingual_migration_schema.yaml +148 -0
  33. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/guidance.py +71 -0
  34. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/i18n/ckanext-metadata-assistant.pot +1827 -0
  35. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/i18n/sv/LC_MESSAGES/ckanext-metadata-assistant.mo +0 -0
  36. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/i18n/sv/LC_MESSAGES/ckanext-metadata-assistant.po +2009 -0
  37. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/i18n/sv_SE/LC_MESSAGES/ckanext-metadata-assistant.mo +0 -0
  38. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/i18n/sv_SE/LC_MESSAGES/ckanext-metadata-assistant.po +2009 -0
  39. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/jobs.py +325 -0
  40. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/limits.py +293 -0
  41. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/link_results.py +122 -0
  42. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/llm/__init__.py +31 -0
  43. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/llm/assistant.py +249 -0
  44. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/llm/base.py +38 -0
  45. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/llm/contracts.py +213 -0
  46. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/llm/prompts.py +269 -0
  47. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/localization.py +65 -0
  48. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/markdown.py +67 -0
  49. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/migrate_ai.py +210 -0
  50. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/migration/__init__.py +0 -0
  51. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/migration/metadata_assistant/__init__.py +0 -0
  52. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/migration/metadata_assistant/alembic.ini +30 -0
  53. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/migration/metadata_assistant/env.py +44 -0
  54. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/migration/metadata_assistant/script.py.mako +22 -0
  55. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/migration/metadata_assistant/versions/001_create_translation_proposal.py +37 -0
  56. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/migration/metadata_assistant/versions/002_create_review_cache.py +31 -0
  57. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/model.py +49 -0
  58. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/multilingual.py +154 -0
  59. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/page_fetch.py +239 -0
  60. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/plugin.py +164 -0
  61. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/profiles.py +212 -0
  62. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/proposals.py +233 -0
  63. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/rules/__init__.py +12 -0
  64. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/rules/data_services.py +205 -0
  65. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/rules/engine.py +421 -0
  66. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/rules/links.py +86 -0
  67. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/rules/profile.py +321 -0
  68. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/rules/translations.py +231 -0
  69. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/templates/.gitkeep +0 -0
  70. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/templates/admin/base.html +7 -0
  71. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/templates/metadata_assistant/admin/_nav.html +7 -0
  72. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/templates/metadata_assistant/admin/ai_instructions.html +100 -0
  73. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/templates/metadata_assistant/admin/check_settings.html +103 -0
  74. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/templates/metadata_assistant/admin/overview.html +38 -0
  75. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/templates/metadata_assistant/help.html +42 -0
  76. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/templates/metadata_assistant/snippets/review_panel.html +175 -0
  77. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/templates/metadata_assistant/translations.html +57 -0
  78. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/templates/package/snippets/package_form.html +6 -0
  79. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/tests/__init__.py +0 -0
  80. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/tests/conftest.py +46 -0
  81. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/tests/test_actions_ai.py +319 -0
  82. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/tests/test_admin_settings.py +119 -0
  83. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/tests/test_ai_contract.py +137 -0
  84. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/tests/test_ai_wiring.py +22 -0
  85. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/tests/test_buttons.py +21 -0
  86. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/tests/test_checks.py +119 -0
  87. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/tests/test_i18n.py +51 -0
  88. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/tests/test_instructions.py +201 -0
  89. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/tests/test_jobs.py +330 -0
  90. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/tests/test_languages.py +83 -0
  91. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/tests/test_limits.py +184 -0
  92. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/tests/test_llm.py +344 -0
  93. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/tests/test_markdown.py +92 -0
  94. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/tests/test_migrate_ai.py +156 -0
  95. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/tests/test_multilingual.py +127 -0
  96. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/tests/test_overview.py +42 -0
  97. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/tests/test_page_fetch.py +348 -0
  98. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/tests/test_profile_selection.py +74 -0
  99. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/tests/test_profiles.py +237 -0
  100. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/tests/test_proposals.py +276 -0
  101. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/tests/test_rules.py +503 -0
  102. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/tests/test_translation.py +315 -0
  103. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/tests/test_without_tables.py +33 -0
  104. ckanext_metadata_assistant-0.1.0/ckanext/metadata_assistant/views.py +299 -0
  105. ckanext_metadata_assistant-0.1.0/ckanext_metadata_assistant.egg-info/PKG-INFO +740 -0
  106. ckanext_metadata_assistant-0.1.0/ckanext_metadata_assistant.egg-info/SOURCES.txt +113 -0
  107. ckanext_metadata_assistant-0.1.0/ckanext_metadata_assistant.egg-info/dependency_links.txt +1 -0
  108. ckanext_metadata_assistant-0.1.0/ckanext_metadata_assistant.egg-info/entry_points.txt +2 -0
  109. ckanext_metadata_assistant-0.1.0/ckanext_metadata_assistant.egg-info/namespace_packages.txt +1 -0
  110. ckanext_metadata_assistant-0.1.0/ckanext_metadata_assistant.egg-info/requires.txt +4 -0
  111. ckanext_metadata_assistant-0.1.0/ckanext_metadata_assistant.egg-info/top_level.txt +1 -0
  112. ckanext_metadata_assistant-0.1.0/pytest.ini +4 -0
  113. ckanext_metadata_assistant-0.1.0/setup.cfg +4 -0
  114. ckanext_metadata_assistant-0.1.0/setup.py +64 -0
  115. ckanext_metadata_assistant-0.1.0/test.ini +38 -0
@@ -0,0 +1,14 @@
1
+ # AI assistance disclosure
2
+
3
+ The implementation and documentation of ckanext-metadata-assistant were developed by Björn Hagström with assistance from
4
+ Anthropic's Claude Code and OpenAI's Codex.
5
+
6
+ AI tools assisted with design discussion, code drafting, refactoring, review and documentation. Product decisions and
7
+ acceptance of the resulting work remain human decisions.
8
+
9
+ The human maintainer is the author, copyright holder and accountable project maintainer. AI systems are not listed as
10
+ authors or maintainers. Before a public release, the maintainer is expected to review the released diff, verify the
11
+ documented behavior and accept responsibility for correctness, security, licensing and provenance.
12
+
13
+ Contributors should disclose material generative-AI assistance in their pull request description. Disclosure does not
14
+ replace review, tests or the contributor's responsibility for the submitted material.
@@ -0,0 +1,39 @@
1
+ # Changelog
2
+
3
+ All notable changes to this project will be documented in this file. The format
4
+ is based on Keep a Changelog, and the project follows Semantic Versioning.
5
+
6
+ ## [0.1.0] - 2026-11-20
7
+
8
+ The first public release.
9
+
10
+ ### Added
11
+
12
+ - **A review panel in CKAN's dataset form.** A rule check without AI (required and recommended fields, themes outside the
13
+ vocabulary, short descriptions, duplicate keywords, a missing licence, address slips, missing or outdated translations,
14
+ and more), under its own heading and run again as the form changes; and, optionally, AI suggestions for the title,
15
+ description, keywords and theme, each applied by the editor or not at all.
16
+ - **Translation suggestions** for title, description and keywords into the schema's other languages (ckanext-fluent),
17
+ in the form and in bulk (`propose-translations`), stored as proposals that an editor reads and applies.
18
+ - **The portal's own languages:** labels, help texts and theme labels given per language follow the page's language and
19
+ the portal's main language (`ckan.locale_default`), and landing pages are asked for in the metadata's language; no language is
20
+ preferred by default.
21
+ - **Landing pages as material:** the portal fetches a public https page itself (or the AI service does, for models that
22
+ can), summarises it once and reuses the summary; a page that was not used says why.
23
+ - **Administration pages** for sysadmins: the check settings with a setup check (including the landing page field and
24
+ the AI connection), the instructions to the AI (editable, with a trial on a dataset), a catalogue-wide overview of
25
+ what the rules find, and the translation proposals page for editors.
26
+ - **Background jobs and limits** for many editors at once: a worker (`ckan metadata-assistant worker`), queues, limits
27
+ per user and site, and a breaker for a failing AI service; without a worker the requests run in the web request.
28
+ - **Commands:** `doctor`, `worker`, `queue`, `review-all`, `propose-translations`, `migrate-multilingual` and
29
+ `migrate-ai-settings`.
30
+ - **The AI connection through [ckanext-ai-connector](https://github.com/bjornhagstrom/ckanext-ai-connector)** (`>=0.1,<0.2`),
31
+ shared with other extensions: model, key, own AI server and time limits are set there. A review or translation that
32
+ fails says why (the service busy, too slow, or out of quota).
33
+ - English source texts with a Swedish catalogue (`sv`, `sv_SE`).
34
+
35
+ ### Upgrading from a development version
36
+
37
+ Development versions kept their AI settings under this extension's own names. `ckan metadata-assistant
38
+ migrate-ai-settings [--dry-run]` copies them to ckanext-ai-connector once, and `--remove-old` removes the old rows; the
39
+ setup check says when something still waits. See the README, "Upgrading from the settings this extension had".
@@ -0,0 +1,35 @@
1
+ # Contributing
2
+
3
+ Thank you for helping improve ckanext-metadata-assistant. The extension is in development (0.x), so bug reports,
4
+ compatibility results (CKAN version, dataset schema, AI service and model) and feedback on the rule check and the
5
+ suggestions are especially useful.
6
+
7
+ ## Before opening an issue
8
+
9
+ - search existing issues;
10
+ - include the CKAN, Python and ckanext-ai-connector versions, the dataset schema (ckanext-scheming, ckanext-fluent or none)
11
+ and the model (`service/name`) used;
12
+ - describe the expected and actual result;
13
+ - include reproducible steps and relevant logs with keys, credentials and personal data removed.
14
+
15
+ Use a private security report instead of a public issue for vulnerabilities; see [SECURITY.md](SECURITY.md).
16
+
17
+ ## Pull requests
18
+
19
+ 1. Keep each pull request focused.
20
+ 2. Add or update tests when changing behavior. Run the suite as the README's "Testing" section shows; continuous
21
+ integration runs it on CKAN 2.11.1, the newest 2.11 patch and 2.12, and runs the JavaScript tests.
22
+ 3. Update the README, TROUBLESHOOTING and changelog when user-visible behavior changes.
23
+ 4. Internationalize all new user-visible strings: wrap them in `_(...)` with English source text (in JavaScript, through
24
+ the panel's `data-i18n` strings), then add the Swedish `msgstr` to
25
+ `ckanext/metadata_assistant/i18n/sv/LC_MESSAGES/ckanext-metadata-assistant.po` and `sv_SE`, and compile the `.mo`
26
+ files. The tests fail when an extracted string has no translation or a `.mo` does not match its `.po`.
27
+ 5. Never let the AI save or publish anything: suggestions are applied by an editor. Never log a key, a prompt or an
28
+ answer from the AI service; log failures by type and status code.
29
+ 6. Disclose material generative-AI assistance in the pull request description (see [AI_ASSISTANCE.md](AI_ASSISTANCE.md)).
30
+
31
+ ## Translations
32
+
33
+ A new language is welcome as a pull request: add
34
+ `ckanext/metadata_assistant/i18n/<locale>/LC_MESSAGES/ckanext-metadata-assistant.po` and its compiled `.mo`. No code
35
+ change is needed; the plugin offers every compiled catalogue.
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Björn Hagström
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,10 @@
1
+ include README.md LICENSE CHANGELOG.md TROUBLESHOOTING.md SECURITY.md CONTRIBUTING.md AI_ASSISTANCE.md
2
+ include ckanext/metadata_assistant/config_declaration.yaml
3
+ recursive-include ckanext/metadata_assistant/templates *
4
+ recursive-include ckanext/metadata_assistant/assets *
5
+ recursive-include ckanext/metadata_assistant/i18n *
6
+ recursive-include ckanext/metadata_assistant/migration *
7
+ recursive-include ckanext/metadata_assistant/examples *.yaml
8
+ include babel.cfg babel_ckan_tag_shims.py pytest.ini test.ini
9
+ global-exclude *.py[cod]
10
+ prune **/__pycache__