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.5.tar.gz
(28.5 kB
view hashes)
Built Distribution
Close
Hashes for ckanext_check_link-0.0.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 561845dfe8ec046492b4a10b85313ac6bb83bf3d8e1e29a92dfc603a994337f3 |
|
MD5 | eeb9083241b5d67c994ddf0273b7a2ee |
|
BLAKE2b-256 | 19cf356ac682f9724cf4d964c3c554fc48acc37e47c04605e4950e3da68e63c8 |