Skip to main content

Fast Markdown Stripper

Project description

qstrip

GitHub stars Build Status License

A fast Markdown stripper with a C backend.

Installation

pip install qstrip

Usage

from qstrip import strip_markdown

with open('markdown_file.md', 'r') as f:
    content = f.read()

stripped_content = strip_markdown(content)
print(stripped_content)

# If the input markdown could potentially be very long, you can specify a timeout
try:
    stripped_content = strip_markdown(content, timeout=2) # 2 second timeout
except TimeoutError:
    stripped_content = None

Current and planned features

  • Strip headings
  • Strip bold tags
  • Strip italic tags
  • Strip strikethrough tags
  • Strip code blocks
  • Strip inline code
  • Strip links
  • Strip images
  • Strip tables
  • Handle images inside links
  • Strip lists
  • Strip blockquotes
  • Strip horizontal rules
  • Strip footnotes
  • Strip reference links
  • Handle escape sequences
  • Support other markup formats (e.g., reStructuredText, HTML/XML)

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

qstrip-0.2.0.tar.gz (8.9 kB view details)

Uploaded Source

File details

Details for the file qstrip-0.2.0.tar.gz.

File metadata

  • Download URL: qstrip-0.2.0.tar.gz
  • Upload date:
  • Size: 8.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for qstrip-0.2.0.tar.gz
Algorithm Hash digest
SHA256 320a0ad734f32f51acf4259f7f49cc3eddb58f9f791d152cf8d735ae1ad2f689
MD5 416d2af712d121a0874193a49c2fc00a
BLAKE2b-256 9eae919f2ccd7c2fa8862c66fc4b9cef4df568816cfef16a084961c29fa06f5d

See more details on using hashes here.

Provenance

The following attestation bundles were made for qstrip-0.2.0.tar.gz:

Publisher: python-publish.yml on carl-vbn/qstrip

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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