Health checks for your documentation links.
Project description
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
and504
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
# if you using Python 3.5 on the mac, install new version of pip
curl https://bootstrap.pypa.io/get-pip.py | python3.5
# if you using other version, just upgrade pip
pip install --upgrade pip
# in case if you developing within forked repository
cd /home/user/deadlinks-fork
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 ondevelop
. - Install package using development instructions.
- Implement your feature and test it with
make tests
andmake lints
. - Create
pull request
back todevelopment
branch.
All your contributions are welcome!
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
deadlinks-0.3.0.tar.gz
(24.4 kB
view hashes)
Built Distribution
deadlinks-0.3.0-py3-none-any.whl
(41.0 kB
view hashes)
Close
Hashes for deadlinks-0.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 59eeb25812fdca7142be499c52c853a83f90a3d9b1fb53c940e76f528da9d218 |
|
MD5 | 02e93fc337084eeb66c67c65b4f2e4c3 |
|
BLAKE2b-256 | f76e8631917bfb49e409102761049332ba336d4b9af80932bafbf2eb7cfab3d3 |