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.8.tar.gz (23.9 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: linkstatus-0.8.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/46.0.0 requests-toolbelt/0.9.1 tqdm/4.44.0 CPython/3.7.7

File hashes

Hashes for linkstatus-0.8.tar.gz
Algorithm Hash digest
SHA256 9ff0ea6d8fc29f24661a1e347ae8c02fbc1c48be7be907a94c628b5aca0a1a11
MD5 70285cc0b2f99a9afdea20868e9fd218
BLAKE2b-256 2a630308db92136d0f33a2ae561608ad18a5a263ce5b8d4db8f93e3ed68369f1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: linkstatus-0.8-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.0.0 requests-toolbelt/0.9.1 tqdm/4.44.0 CPython/3.7.7

File hashes

Hashes for linkstatus-0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 61872cda0f4118b23a4bd1caed1ec256bff42f19a0eb2380ee17edc647241b97
MD5 8e92fd67f27584f6f22add80fb590f87
BLAKE2b-256 605b3e11fde1307c7efbbdd589d8de6027cf76e700e8889369cd5e96f06beff2

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