comverter 0.1.0

ComVerter - The Common Converter

ComVerter - The Common Converter

ComVerter is a simple C Python extension that I plan to use for converting some simple formats to others. Like Markdown to HTML, HTML to PDF, and many others.

Features

• Markdown to HTML
• HTML to PDF

Want another format? Open an issue or submit a pull request.

Build & Install (Release)

This project uses uv as the release build tool.

# Build the wheel for the current Python version
uv build --wheel

# Install the wheel
uv pip install dist/comverter-*.whl

Usage

>>> from comverter import markdown_to_html, markdown_file_to_html, ALL_MARKDOWN_EXTENSIONS

>>> markdown_to_html("Hello, **world**!")
'<p>Hello, <strong>world</strong>!</p>\n'

# Convert a Markdown file to HTML
>>> markdown_file_to_html("input.md", "output.html")

# Enable all extensions at once
>>> markdown_to_html("Hello **world**", extensions=ALL_MARKDOWN_EXTENSIONS)
'<p>Hello <strong>world</strong></p>\n'

# Enable extensions individually
>>> markdown_to_html("http://example.com", extensions=["autolink"])
'<p><a href=\"http://example.com\">http://example.com</a></p>\n'

>>> markdown_to_html("<script>", extensions=["tagfilter"])
'&lt;script>\n'

Supported Markdown features

• ATX headings — # H1 through ###### H6
• Paragraphs — consecutive lines of text
• Emphasis — *italic* and _italic_
• Strong emphasis — **bold** and __bold__
• Code spans — `code`
• Links — [text](url) with optional "title"
• Images — ![alt](src) with optional "title"
• Fenced code blocks — ``` and ~~~
• Blockquotes — > quote
• Unordered lists — - item, * item, + item
• Ordered lists — 1. item
• Thematic breaks — ---, ***, ___
• Hard line breaks — two trailing spaces
• Backslash escapes — \*, \[, etc.
• Automatic HTML escaping — <, >, &, "
• Setext headings — Heading\n=== (level 1) and Heading\n--- (level 2)
• GFM pipe tables — \| a \| b \|\n\|---\|---\|\n\| 1 \| 2 \| with optional alignment

Extensions

Pass the extensions parameter with a list of extension names, or use ALL_MARKDOWN_EXTENSIONS to enable all at once.

Extension	Description
"autolink"	Auto-link URLs and email addresses
"tagfilter"	Filter out certain HTML tags for security

See docs/md_extensions.md for detailed documentation of each extension.

Development

Makefile targets

Run make help to see all available targets:

Target	Description
make setup	Create venv and configure meson
make reconfigure	Reconfigure meson
make build	Build the C extension and wheel
make install	Install the package in editable mode
make test	Run tests (stop after 3 failures)
make format	Run all source formatters
make test-all	Run all tests
make clean	Remove all build artifacts

LSP

Once meson is configured (make setup), compile_commands.json is generated automatically, giving you completions, diagnostics, and go-to-definition for the Python C API.

Task Management

This project uses Tigo for task management. Tasks are stored as TASK.md files under .tigo/YYYYMMDD-HHmmss/.

Disclaimer

This repository is being developed using AI assistance.

References

• Python C API
• GitHub Flavored Markdown
• CommonMark
• Markdown on WikiPedia
• HTML Spec
• RFC 2854
• RFC 7763
• RFC 7764
• RFC 8118