Skip to main content

Perform connectivity checks on URLs listed in the Markdown

Project description

linkstat

test-lint-format License: MIT

linkstat is a script that verifies the connectivity of links documented in the documentation. By detecting broken links early, it maintains the integrity of the documentation.
Currently, only Markdown files (*.md) are supported.

Caution

This library accesses services during runtime, so executing it in large quantities will cause load on the target service. When performing functional verification or integrating into CI/CD, please ensure the load on the linked service is minimized as much as possible.

Install

pip install linkstat

Usage

linkstat {source_file_or_directory}

Output

You can output reports in JSON format by using the option.

linkstat --report-json {path} {source_file_or_directory}

Contribute

Guideline

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

linkstat-1.0.1.tar.gz (215.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

linkstat-1.0.1-py3-none-any.whl (7.2 kB view details)

Uploaded Python 3

File details

Details for the file linkstat-1.0.1.tar.gz.

File metadata

  • Download URL: linkstat-1.0.1.tar.gz
  • Upload date:
  • Size: 215.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.28.1

File hashes

Hashes for linkstat-1.0.1.tar.gz
Algorithm Hash digest
SHA256 6795708aa1144ad022db0e758fdf086debebab54ad01af09bef8e630f2c786ea
MD5 450563874b251620af651f97782c8486
BLAKE2b-256 2b6a2cb463ab0b9ed4db85d68ac584aa882ec9f97dcae7e258416961e87d2e05

See more details on using hashes here.

File details

Details for the file linkstat-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: linkstat-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 7.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.28.1

File hashes

Hashes for linkstat-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e0d753fdb188004ab2fda32c2a32838f95cc345b9c592d1428593b8e46ad974b
MD5 7c0e3fd5ab26bf6f5e15af2f1d63169e
BLAKE2b-256 078b0d248667916681b2e57c5fdfd9fdb155083106d35c166ce70e333361322b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page