deadlinks

Health checks for your documentation links.

Features

Concurrent and recursive checks
Respect robots.txt restrictions (content only)
External links checks
Checking links within base url path
Retries in the case of 502, 503 and 504 http errors

Installing

Using package installer for Python

# using pip - package installer for Python
pip install deadlinks

Mac

# we using custom tap to install deadlinks
brew install butuzov/deadlinks/deadlinks

Using forked repo for development propose.

# activate virtual environment to keep your local site-packages clean.
python3 -m venv .venv
source .venv/bin/activate
pip install --upgrade pip

# in case if you developing within forked repository
cd /home/path/to/deadlinks
pip install -r requirements.txt
pip install -e .

Usage

See more examples at docs

# Check links (including external) at http://gobyexample.com/ in 10 threads,
# but not ones that leading to domains play.golang.org or github.com
deadlinks gobyexample.com -n 10 -e -d play.golang.org -d github.com

# Limiting check only to links found within /docs path.
deadlinks http://localhost:1313/docs

# Running checks for all local links that belong to a domain.
deadlinks http://localhost:1313/docs/ -n 10 --full-site-check

# Checking local html files
deadlinks internal -n 10 --root=/var/html

# Help yourself
deadlinks --help

Contributing

Here is a quick start guide to contributing to deadlinks

Fork deadlinks repository.
Create feature branch based on develop.
Install package using development instructions.
Implement your feature and test it with make tests and make lints.
Create pull request back to development branch.

All your contributions are welcome!

Release files for deadlinks 0.3.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for deadlinks 0.3.5
File	Size	Uploaded
deadlinks-0.3.5.tar.gz	29.3 kB	Dec 31, 2023	Details

Release files / deadlinks-0.3.5.tar.gz

Download URL	deadlinks-0.3.5.tar.gz
Size	29.3 kB
Tags	Source
SHA-256 checksum How to use checksums	`ec2d5584858d13a0a16967f96a8a377a658c0e36b933a900d7fd37e502e1e149`
BLAKE2b-256 checksum How to use checksums	`1b053e6ef8ca1e1808d9c9d2c9bdfcb78fa8d80e1e54dfd5608c3e9adcfc5474`
Upload date	Dec 31, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.11.7`