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.2.tar.gz (13.4 kB view details)

Uploaded Source

Built Distribution

wagtail_linkchecker-0.5.2-py3-none-any.whl (22.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: wagtail-linkchecker-0.5.2.tar.gz
  • Upload date:
  • Size: 13.4 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.2.tar.gz
Algorithm Hash digest
SHA256 4d40afe3a5f64f6635ca1f6f778c3ba3e030322e01302b11bbaa0c68b587c816
MD5 27723a921e499deb49c15da9da5e647c
BLAKE2b-256 23c4112c9681e75050b986206fdcaf08cbda356176202e17b9cfa79db38efd93

See more details on using hashes here.

File details

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

File metadata

  • Download URL: wagtail_linkchecker-0.5.2-py3-none-any.whl
  • Upload date:
  • Size: 22.5 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 41d3cb1af3c4890d0f15fce26d504b92053acc8207c76e0354711ded103ef832
MD5 d71cb6fd35fad05da3e761223b12966c
BLAKE2b-256 87c56b42c7e9c4420f00c00629cc60513ab667237f6267bfb5e2f9a16f921838

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