Skip to content

Repository files navigation

LinkStatus

Check link status

Python VersionsPyPI versionDownloadsgithub actionsLicense: GPLv3Code style: black

This is simple link status checker for text/markdown files.

Install

  • pip

    pip install linkstatus --user
  • source

    pip install . --user

Usage:

❯❯❯ linkstatus --help
Usage: linkstatus [OPTIONS] [SOURCE]...
Check Link Status
Options:
-r, --recursive Include all files from directories recursively
-t, --timeout INTEGER Request timeout (default 4 second)
-rt, --retry INTEGER Retry link status (default 2 time)
--help Show this message and exit.
❯❯❯ linkstatus tests/data/markdown_file.md
Links in File: 'tests/data/markdown_file.md'
✓ L4 : https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
✓ L8 : http://www.google.com
✓ L10 : https://www.google.com
✓ L12 : https://github.com/pythonpune/linkstatus
✓ L24 : http://www.example.com
✗ L34 : https://github.com/pythonpune/linkcheck (404)
✓ L39 : https://github.com//pythonpune/
… L41 : http://<hostname>:<port> (skip)
… L43 : https://<hostname>:<port>/pages (skip)
=================================================================================================================
Links Status Summary
Links UP: 6
Links SKIP: 2
Links DOWN: 1
Warning: Use `noqa` inline comment to skip link check. like, response code 403 due to header restrictions etc...
=================================================================================================================

Note: Skip link check for any line by adding noqa (no quality assurance) as inline comment . like <-- noqa --> for html and markdown, #noqa for python etc...

CONTRIBUTION GUIDELINES

If you would like to contribute please read the project contribution guidelines here.

CODE OF CONDUCT

For the community code of conduct please follow the following link.

About

Simple text/ markdown links status checker

Resources

Contributing

Stars

8 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages