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-link
pip install ckanext-check-link
-
Add
check_link
to theckan.plugins
setting 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
Project details
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
ckanext-check-link-0.0.11.tar.gz
(29.4 kB
view hashes)
Built Distribution
Close
Hashes for ckanext-check-link-0.0.11.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1af1a75bee5718cddc035abe4080e97b696df26c46fbb75f02a7ace1618b5d1b |
|
MD5 | e55beaae2ca22a1fc30ffd2f58fa41e1 |
|
BLAKE2b-256 | a52fdf804a88d590426cf3162a46dd76c61e6169d6f81be37305507e7a29b792 |
Close
Hashes for ckanext_check_link-0.0.11-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f2eb928ee27877b3e0aec14ef0bc4761cdb2f5cdb7339c149b63e11e3b9d75f2 |
|
MD5 | 922a3901e652336317846416e55bd279 |
|
BLAKE2b-256 | b800da76353ff55bcce2a4cb98b0f1fe10883d383e636d8ebbd0145a3471028a |