Skip to main content

Basic link checker

Project description

🌎 blinkcheck - a basic link checker

Latest Release PyPI Version MIT License

Check for dead links in all files, with support for regex URL extraction and glob file patterns.

Installation

pip install blinkcheck

Usage Examples

Check for dead links in all files, starting in the current directory.

blinkcheck

Check for dead links in all Markdown *.md files of a specific ./docs folder.

blinkcheck --root ./docs -i *.md

Check for dead links in LaTeX *.tex files in the current directory with regex \\url{(.*?)}.
If a regex contains one group constructs, the group is used as the link.

blinkcheck -i *.tex -r "\\url{(.*?)}"

Only list failed links and do not verify SSL certificates.

blinkcheck --skip-ssl --only-fails

Available Arguments

Argument Default Value Description
--root . (current directory) Directory in which we recursively check matching files.
-i --include *.* (all files) A glob pattern that files have to match.
-r --regex see here Regex to extract URLs with group syntax support.
--skip-ssl Do not verify the SSL certificate when performing requests.
--only-fails Only output failed requests.

Development

Install Poetry and setup your environment.

poetry install
poetry shell

Run tests with pytest.

poetry run pytest

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

blinkcheck-0.1.1.tar.gz (5.7 kB view hashes)

Uploaded Source

Built Distribution

blinkcheck-0.1.1-py3-none-any.whl (6.2 kB view hashes)

Uploaded Python 3

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