Skip to main content

Simple text/ markdown links status checker

Project description

LinkStatus

Check link status

Python Versions PyPI version Downloads github actions 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-1.0.tar.gz (24.6 kB view details)

Uploaded Source

Built Distribution

linkstatus-1.0-py3-none-any.whl (17.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: linkstatus-1.0.tar.gz
  • Upload date:
  • Size: 24.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.8.5

File hashes

Hashes for linkstatus-1.0.tar.gz
Algorithm Hash digest
SHA256 b85b6588197148848afff90163d335cb9232edf4bcd03fd3eb022d1a28bdb271
MD5 33ef9d8a2645b3a3aea56aaa286b76ca
BLAKE2b-256 a3d33e369e78a8b399e1fc9ffed734a8a5c1ecf31d6f327d819374e92e154a1d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: linkstatus-1.0-py3-none-any.whl
  • Upload date:
  • Size: 17.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.8.5

File hashes

Hashes for linkstatus-1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 26e366ddaf40a85781af7d8e8aab5b36489ad2f5088507ccba6319577b6f490d
MD5 4f149bc13acf45e0e55b0081318de48c
BLAKE2b-256 9e22e703140a982bb0732ea52c8bae5b5b994e452c2424a654c9c842724dc447

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