Metadata-Version: 2.4
Name: qstrip
Version: 0.2.0
Summary: Fast Markdown Stripper
Author-email: Carl von Bonin <contact@carl-vbn.dev>
License-Expression: MIT
Project-URL: Homepage, https://github.com/carl-vbn/qstrip
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# qstrip

![GitHub stars](https://img.shields.io/github/stars/carl-vbn/qstrip)
![Build Status](https://github.com/carl-vbn/qstrip/actions/workflows/python-package.yml/badge.svg)
![License](https://img.shields.io/github/license/carl-vbn/qstrip)

A fast Markdown stripper with a C backend.

## Installation

```bash
pip install qstrip
```

## Usage

```python
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
- [x] Strip headings
- [x] Strip bold tags
- [x] Strip italic tags
- [x] Strip strikethrough tags
- [x] Strip code blocks
- [x] Strip inline code
- [x] Strip links
- [x] Strip images
- [x] Strip tables
- [x] 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)
