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

Uploaded Source

Built Distribution

wagtail_linkchecker-0.5.0-py3-none-any.whl (22.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: wagtail-linkchecker-0.5.0.tar.gz
  • Upload date:
  • Size: 13.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/33.1.1 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.5.3

File hashes

Hashes for wagtail-linkchecker-0.5.0.tar.gz
Algorithm Hash digest
SHA256 26e94cfb57dee79aab6166baca847e4f3b40d7ccda81aff78e303a848901e0b6
MD5 b5ea4a1788fb29c37a8169cc81ea6747
BLAKE2b-256 be32777274142c7caad2908f18b26521b77ee493d922e8598fd8f2a552116b44

See more details on using hashes here.

File details

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

File metadata

  • Download URL: wagtail_linkchecker-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 22.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/33.1.1 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.5.3

File hashes

Hashes for wagtail_linkchecker-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0bfa20a672055833e2fc5b0a0288df87e3e99555e9f235b8416f54c5082e2084
MD5 64fc1761ff135ca23dfbf224bf2272ba
BLAKE2b-256 5d1084f31984a60a378c40208e487ed1e4a7407213b1f198011b2677b7c206da

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