Skip to main content

Simple text/ markdown links status checker

Project description

LinkStatus

Check link status

Python Versions PyPI version Downloads License: GPLv3 Code 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.

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

linkstatus-0.9.tar.gz (25.0 kB view details)

Uploaded Source

Built Distribution

linkstatus-0.9-py3-none-any.whl (17.9 kB view details)

Uploaded Python 3

File details

Details for the file linkstatus-0.9.tar.gz.

File metadata

  • Download URL: linkstatus-0.9.tar.gz
  • Upload date:
  • Size: 25.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.7

File hashes

Hashes for linkstatus-0.9.tar.gz
Algorithm Hash digest
SHA256 299f314fefb247c7270882b5df499b688bf7da529db5cf9f545eca9c772a5e07
MD5 12a867924b73537be88b7f61d21b4a63
BLAKE2b-256 f7827b10798e3b20e5ed13206720e09f7cb88ba7825f67e311c12bab9af7bc47

See more details on using hashes here.

File details

Details for the file linkstatus-0.9-py3-none-any.whl.

File metadata

  • Download URL: linkstatus-0.9-py3-none-any.whl
  • Upload date:
  • Size: 17.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.7

File hashes

Hashes for linkstatus-0.9-py3-none-any.whl
Algorithm Hash digest
SHA256 8f06b1b0325adb9e5b427ec8a2fab96d0d30d40422d9ba9d16fedc90d1e455fb
MD5 553ff796681a97a94512583375a2f597
BLAKE2b-256 941f58528653521c6500392830007f91575783c5c9b6e851d1c1431152cfd12a

See more details on using hashes here.

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