Skip to main content

Simple text/ markdown links status checker

Project description

LinkStatus

Check link status

Python Versions Build Status License: GPLv3 PyPI version Downloads 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.7.tar.gz (23.9 kB view details)

Uploaded Source

Built Distribution

linkstatus-0.7-py3-none-any.whl (17.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: linkstatus-0.7.tar.gz
  • Upload date:
  • Size: 23.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.6

File hashes

Hashes for linkstatus-0.7.tar.gz
Algorithm Hash digest
SHA256 29bd5fe5e1bb90d34624997396fe8380b2e7c93dea6d963a1bceaf09ede7e750
MD5 d4d00d6b4482b50b761783629987a73d
BLAKE2b-256 b6e093652a491b2bac4b0e6acb24f4815bc88c2b615c7db7a5e3e41cefe8fe85

See more details on using hashes here.

File details

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

File metadata

  • Download URL: linkstatus-0.7-py3-none-any.whl
  • Upload date:
  • Size: 17.8 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/45.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.6

File hashes

Hashes for linkstatus-0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 ada3a677e2f657146cff538634af52cf778462e13898c820e6534d25b297bddc
MD5 f80131b557f044a6966568575739ea27
BLAKE2b-256 729cbe311aa278f18f7dc4a0454af7219f54fb1d71a6669218248f99fc61c079

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