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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: wagtail-linkchecker-0.5.4.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.4.tar.gz
Algorithm Hash digest
SHA256 fe5d51e7b129b75cb9b8ebe427a6150d9c5480c2d066d6d10e1e951f4748698c
MD5 d700efcafc0d68b5dca91b26bcb4b214
BLAKE2b-256 4f1d706d4dfe81a3013c51b2cd6c1827c27422a5d2dc7154c988e66f43d1f6ae

See more details on using hashes here.

File details

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

File metadata

  • Download URL: wagtail_linkchecker-0.5.4-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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 d958010f1c20737e55a50c2ae3aa90e918947dd60037d7c949d9b2f769304e8f
MD5 aa023f701a2ebba586cf780ecd5698f4
BLAKE2b-256 317114a6210d70347952b3b80acf35f77f743342e35fe0053542f81bbd213a90

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