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
check-resources
Check every resource on the portal.
Scope can be narrowed via arbitary number of arguments, specifying resource's ID
delete-reports
Delete check-link reports.
# delete all reports
$ ckan check-link delete-reports
# drop reports that point to an unexisting resource
$ ckan check-link delete-reports --orphans-only
Scope can be narrowed via arbitary number of arguments, specifying resource's ID
API
check_link_url_check
check_link_resource_check
check_link_package_check
check_link_organization_check
check_link_group_check
check_link_user_check
check_link_search_check
check_link_report_save
check_link_report_show
check_link_report_search
check_link_report_delete
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
Built Distribution
Hashes for ckanext-check-link-0.1.1.post1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 26bc462efb662b1e2c20fdc08543e5b38deca9e85b2ddb448d18bed6d0d63dbc |
|
MD5 | 81ecd565bd85e0af9ae6db460c746f6c |
|
BLAKE2b-256 | 18fd858ff1a67f9a8b73193ccd53ee033228ec0e34edee95956698175b8cacdf |
Hashes for ckanext_check_link-0.1.1.post1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4e8ee3789dbe58895ca94268b284d9c7361c82e1ebc7706093fd157a78cece8c |
|
MD5 | bea998d6e860760f1bc27b403d8638dc |
|
BLAKE2b-256 | 08a6c50636ee9b59979b3962d89c9fccf668f6607959f027edc8e78b50d87035 |