Skip to main content

A tool to assist with finding broken links on your wagtail site.

Project description

A tool/plugin to assist with finding broken links on your wagtail site. This tool works asynchronously using celery.

Installing

Install using pip:

pip install wagtail-linkchecker

It works with Wagtail 1.0 and upwards.

Using

To use, firstly you will need to add wagtaillinkchecker to your INSTALLED_APPS and run the migrations. There will now be an extra item on the settings panel of the wagtailadmin. Inside here you can enable or disable automated scanning (See below for more detail) or conduct a scan.

For scans to be conducted, you must be running a celery daemon. You can run the celery worker with celery -A wagtaillinkchecker worker -l info. See the Celery Documentation for more information. For production you’ll want to run celery as a daemon using something like systemd. See Celery Daemonization for more information.

Conducting a scan

Conducting a scan will scan all of your wagtail pages, and detect all images and anchors with a src or href respectively. Utilising the requests and BeautifulSoup libraries, requests will be made to each link to make sure an appropriate response is received, and if no appropriate response is received, once the scan is complete, all broken links along with their status codes and reasons will appear.

Scan results will be stored.

Automated Scanning

If you want automated scanning to work you HAVE to set up a cron job. The cron job will need to run the management command linkchecker at an interval of your choosing. The automated scans will do the same as manually conducting a scan, but instead will email the last person to edit the page with broken links/images.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wagtail-linkchecker-0.5.3.tar.gz (13.6 kB view details)

Uploaded Source

Built Distribution

wagtail_linkchecker-0.5.3-py3-none-any.whl (22.8 kB view details)

Uploaded Python 3

File details

Details for the file wagtail-linkchecker-0.5.3.tar.gz.

File metadata

  • Download URL: wagtail-linkchecker-0.5.3.tar.gz
  • Upload date:
  • Size: 13.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.6.5

File hashes

Hashes for wagtail-linkchecker-0.5.3.tar.gz
Algorithm Hash digest
SHA256 483bca0f06c3cda26d2a62c8dc59a650a4a77d25eb9e11b6b5eb0444882225ab
MD5 51c53d371205f29922961f5bf4a815a2
BLAKE2b-256 595ed1e8f9969a4905031c4f1c8d07dc935a752700febbbdc71f0e9e3afe2ec1

See more details on using hashes here.

File details

Details for the file wagtail_linkchecker-0.5.3-py3-none-any.whl.

File metadata

  • Download URL: wagtail_linkchecker-0.5.3-py3-none-any.whl
  • Upload date:
  • Size: 22.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.6.5

File hashes

Hashes for wagtail_linkchecker-0.5.3-py3-none-any.whl
Algorithm Hash digest
SHA256 1339bebf801e86a976a80f0f9ba0ae8f38d0139286c5dc736988acb9f9ec88c3
MD5 d3486b34c6a6de285cce324caca60be5
BLAKE2b-256 9606f1f04efdff04fa2df9b3fb19f767aefb1073841ccca1da5b3c5fda567160

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page