CLI/API for links liveness checking.
Project description
deadlinks is a simple cli tool to check your documentation/website for deadlinks.
Features
- Concurrent and recursive checks
- 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
# run 10 instances of crawler against https://gobyexample.com.ua
# with the additional check for the external links (except ones that
# match play.golang.org)
deadlinks https://gobyexample.com.ua -n 10 -e -d play.golang.org
# get more help with
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!
Alternatives
These are a lot of alternative ways to check your website for dead links errors, you can check a open software or check other options:
Platform | Title | Link |
---|---|---|
mac , ui |
Integrity | https://peacockmedia.software/mac/integrity/free.html |
win , ui |
Xenu's Link Sleuth | http://home.snafu.de/tilman/xenulink.html |
web |
Online Broken Link Checker | https://www.brokenlinkcheck.com/ |
web |
Free Broken Link Tool | https://www.deadlinkchecker.com/website-dead-link-checker.asp |
win , ui |
InterroBot | https://interro.bot/ |
go , cli |
muffet | https://github.com/raviqqe/muffet |
cli , ui , web |
linkchecker | https://wummel.github.io/linkchecker |
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.2.1.tar.gz
(24.8 kB
view hashes)
Built Distribution
deadlinks-0.2.1-py3-none-any.whl
(39.8 kB
view hashes)
Close
Hashes for deadlinks-0.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 012c6163c184ee02c63b5818cd2e5201191a61ab70e8f7c62eed2c98a01f1386 |
|
MD5 | 9e639b6117205ec151120d57892f2fcd |
|
BLAKE2b-256 | c24fecfd4006cc446dfa9597873148fe3dac70160e2e0e85451fc8115de361cd |