Skip to main content

Markdown URL Checker

>> Simple CLI tool to check URL health in markdown files <<

 

img

This CLI tool traverses down a markdown file, extracts all the valid URLs, and checks whether they're accessible or not. In case it encounters a broken link, it raises an error. Internally, this is optimized for larger markdown files and tested for huge markdown files with thousands of links.

Installation

Install the CLI using pip:

pip install md-url-checker

Usage

  • To check the URLs in a single markdown file, run:

    md-url-check -f file.md
    
  • To check the URLs in multiple markdown files, run:

    echo 'file1.md file2.md' | xargs -n 1 md-url-check -f
    
  • To check the URLs in multiple files in a folder, run:

    find . -name '*.md' | xargs -n 1 --no-run-if-empty md-url-check -f
    
  • Suppress intermediate output:

    md-url-check -f file.md -s
    
  • Provide the number of threads to be used while making the requests:

    md-url-check -f file.md -s -t 32
    

    This uses 32 interleaving threads to make the requests concurrently. Default is 8.

✨ 🍰 ✨

Metadata

Release files for md-url-check 0.1.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for md-url-check 0.1.4
File Size Uploaded Provenance Actions
md-url-check-0.1.4.tar.gz 4.5 kB Without provenance Details for md-url-check-0.1.4.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for md-url-check 0.1.4
File Interpreter ABI Platform Actions
md_url_check-0.1.4-py3-none-any.whl Python 3 none any Details for md_url_check-0.1.4-py3-none-any.whl

Total release size: 9.2 kB

Release files / md-url-check-0.1.4.tar.gz

Download URL md-url-check-0.1.4.tar.gz
Size 4.5 kB
Tags Source
SHA-256 checksum
How to use checksums
69e0ce73038f0e82cac5cffd3a3339a94621547d7c6d2480a9e399a3ae6e7f5f
BLAKE2b-256 checksum
How to use checksums
abc1e35348bece9d88099837e2a5f909a508136e0828a1ba17e790ff9e78e9fb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.1.8 CPython/3.9.7 Linux/5.11.0-27-generic

Release files / md_url_check-0.1.4-py3-none-any.whl

Download URL md_url_check-0.1.4-py3-none-any.whl
Size 4.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
8d409f54d5d3b11eb20f8a9a6ecf5b2c90f5a3fec061a4e4f4017ddb8d6eb8d7
BLAKE2b-256 checksum
How to use checksums
20c5e70058039e20e970c2fab948c3a28c00c8cafec68ed7be26d75dd98fe304
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.1.8 CPython/3.9.7 Linux/5.11.0-27-generic

Security for md-url-check 0.1.4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page