Resource URL checker
Project description
ckanext-check-link
Link checker for CKAN.
Provides API, CLI commands, and views for:
- checking availability of the file, refereed by resource
- checking availability of any arbitrary link.
- storing results of these checks
- visualizing stored results
Index
Requirements
Compatibility with core CKAN versions:
| CKAN version | Compatible? |
|---|---|
| 2.9 | yes |
| 2.10 | yes |
Installation
-
Install
ckanext-check-linkpip install ckanext-check-link -
Add
check_linkto theckan.pluginssetting in your CKAN config file.
Config settings
# Allow any logged-in user to check links. This implies specific security issues,
# thus disabled by default.
# (optional, default: false).
ckanext.check_link.user_can_check_url = yes
# URL for the "Link availability" page.
# (optional, default: /check-link/report/global)
ckanext.check_link.report.base_template = /ckan-admin/link-state
# A base template that is extended by the "Link availability" page.
# (optional, default: check_link/base_admin.html)
ckanext.check_link.report.base_template = check_link/base.html
UI
Link availability
Endpoint: check_link.report
Path: /check-link/report/global
Paginated listing of all the "broken" links. Access is controlled by the
check_link_view_report_page auth function, which can be bypassed only by
sysadmin.
CLI
CLI commands are registered under ckan check-link route.
check-packages
Check every resource inside each package.
The scope can be narrowed via arbitrary number of arguments, specifying the package's ID or name.
# check all the public packages
$ ckan check-link check-packages
# check all the active packages
$ ckan check-link check-packages --include-private
# check all the public and draft pacakges
$ ckan check-link check-packages --include-draft
# check only two specified packages
$ ckan check-link check-packages pkg-id-one pkg-name-two
API
TBA
License
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file ckanext-check-link-0.0.13.tar.gz.
File metadata
- Download URL: ckanext-check-link-0.0.13.tar.gz
- Upload date:
- Size: 29.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 02bad6bf164e50814f79b4a13780ffe021ac937227b22f61d858288ce62ee2ec |
|
| MD5 | 8bafd64d8f498ecdb4bcfb4dc317ba9e |
|
| BLAKE2b-256 | 5a822d7bc985431bfe57218b2f4f28bd005566f2b5f3ba9152ed98c594a423f3 |
File details
Details for the file ckanext_check_link-0.0.13-py3-none-any.whl.
File metadata
- Download URL: ckanext_check_link-0.0.13-py3-none-any.whl
- Upload date:
- Size: 36.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f1e935ea271a392e4d398bb6ff19781427a742f7a65263670ca79cbab5f9c87f |
|
| MD5 | 2d78f34df37dbfb8af769dae8b4cde66 |
|
| BLAKE2b-256 | acff290e4a799f2d2b9fc2218bd07d9d02a41068593f88565ac09ed7cf22755f |
