md2typst 0.1.0__tar.gz

md2typst-0.1.0/PKG-INFO

@@ -0,0 +1,215 @@
+Metadata-Version: 2.3
+Name: md2typst
+Version: 0.1.0
+Summary: Markdown to Typst converter with multiple parser support
+Author: Stefane Fermigier
+Author-email: Stefane Fermigier <sf@abilian.com>
+Requires-Dist: markdown-it-py>=3.0.0
+Requires-Dist: click>=8.0.0
+Requires-Dist: mistune>=3.0.0
+Requires-Dist: marko>=2.0.0
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+
+# md2typst
+
+A robust Markdown to [Typst](https://typst.app/) converter in Python with support for multiple Markdown parsers.
+
+## Features
+
+- **Multiple parser backends**: Choose from markdown-it-py, mistune, or marko at runtime
+- **GFM support**: Tables, strikethrough, and other GitHub Flavored Markdown extensions
+- **Configurable**: TOML configuration files and CLI options
+- **Extensible**: Plugin support for parser-specific extensions
+- **Well-tested**: Comprehensive test suite with TCK validation against CommonMark
+
+## Installation
+
+```bash
+# Using pip
+pip install md2typst
+
+# Using uv
+uv add md2typst
+```
+
+## Quick Start
+
+### Command Line
+
+```bash
+# Convert a file
+md2typst input.md -o output.typ
+
+# Convert from stdin
+echo "# Hello **World**" | md2typst
+
+# Use a specific parser
+md2typst --parser mistune input.md
+
+# List available parsers
+md2typst --list-parsers
+```
+
+### Python API
+
+```python
+from md2typst import convert
+
+# Simple conversion
+typst = convert("# Hello **World**")
+print(typst)
+# Output: = Hello *World*
+
+# With specific parser
+typst = convert("~~deleted~~", parser="mistune")
+print(typst)
+# Output: #strike[deleted]
+
+# With configuration
+from md2typst import convert_with_config
+from md2typst.config import Config
+
+config = Config(parser="marko", plugins=["gfm"])
+typst = convert_with_config("| A | B |\n|---|---|\n| 1 | 2 |", config)
+```
+
+## Supported Parsers
+
+| Parser | CLI Name | Description |
+|--------|----------|-------------|
+| [markdown-it-py](https://github.com/executablebooks/markdown-it-py) | `markdown-it` | Default. CommonMark compliant, extensible |
+| [mistune](https://github.com/lepture/mistune) | `mistune` | Fast, pure Python |
+| [marko](https://github.com/frostming/marko) | `marko` | CommonMark compliant, extensible |
+
+All parsers have GFM extensions (tables, strikethrough) enabled by default.
+
+## Markdown to Typst Mapping
+
+| Markdown | Typst |
+|----------|-------|
+| `# Heading` | `= Heading` |
+| `## Heading 2` | `== Heading 2` |
+| `*italic*` | `_italic_` |
+| `**bold**` | `*bold*` |
+| `~~strike~~` | `#strike[strike]` |
+| `` `code` `` | `` `code` `` |
+| `[text](url)` | `#link("url")[text]` |
+| `![alt](url)` | `#image("url", alt: "alt")` |
+| `> quote` | `#block(...)[quote]` |
+| `---` | `#line(length: 100%)` |
+| GFM tables | `#table(...)` |
+
+## Configuration
+
+Configuration is loaded from multiple sources (highest priority first):
+
+1. CLI arguments (`--parser`, `--plugin`)
+2. Explicit config file (`--config path/to/config.toml`)
+3. `.md2typst.toml` in the current or parent directories
+4. `[tool.md2typst]` section in `pyproject.toml`
+
+### Example Configuration
+
+**.md2typst.toml**:
+```toml
+parser = "mistune"
+plugins = ["strikethrough", "table"]
+
+[parser_options]
+html = true
+```
+
+**pyproject.toml**:
+```toml
+[tool.md2typst]
+parser = "markdown-it"
+plugins = ["gfm"]
+```
+
+### CLI Options
+
+```bash
+md2typst --help
+
+Options:
+  -o, --output FILE      Output file (default: stdout)
+  -p, --parser NAME      Parser to use (markdown-it, mistune, marko)
+  --plugin NAME          Load parser plugin (can be repeated)
+  --config FILE          Path to configuration file
+  --list-parsers         List available parsers
+  --show-config          Show effective configuration
+```
+
+## Development
+
+### Setup
+
+```bash
+git clone https://github.com/user/md2typst.git
+cd md2typst
+uv sync
+```
+
+### Running Tests
+
+```bash
+# Run all tests (benchmarks skipped by default)
+uv run pytest
+
+# Run by category
+uv run pytest -m unit          # Unit tests (fast)
+uv run pytest -m integration   # Integration tests
+uv run pytest -m e2e          # End-to-end tests
+uv run pytest -m benchmark    # Benchmark tests
+```
+
+### Test Structure
+
+```
+tests/
+├── a_unit/           # Unit tests (AST, generator)
+├── b_integration/    # Integration tests (parsers, config, TCK)
+├── c_e2e/           # End-to-end tests
+├── d_benchmark/     # Performance benchmarks
+└── fixtures/        # Test fixtures (CommonMark, GFM)
+```
+
+### Code Quality
+
+```bash
+# Type checking
+uv run mypy src/
+
+# Linting
+uv run ruff check src/
+
+# Formatting
+uv run ruff format src/
+```
+
+## Architecture
+
+```
+Markdown Input → Parser → AST → Generator → Typst Output
+```
+
+The converter uses a parser-agnostic AST (Abstract Syntax Tree) that decouples parsing from code generation. This allows:
+
+- Swapping parsers without changing the generator
+- Consistent output regardless of parser choice
+- Easy extension with new parsers
+
+## License
+
+MIT
+
+## Contributing
+
+Contributions are welcome! Please:
+
+1. Fork the repository
+2. Create a feature branch
+3. Add tests for new functionality
+4. Ensure all tests pass
+5. Submit a pull request

md2typst-0.1.0/README.md

@@ -0,0 +1,202 @@
+# md2typst
+
+A robust Markdown to [Typst](https://typst.app/) converter in Python with support for multiple Markdown parsers.
+
+## Features
+
+- **Multiple parser backends**: Choose from markdown-it-py, mistune, or marko at runtime
+- **GFM support**: Tables, strikethrough, and other GitHub Flavored Markdown extensions
+- **Configurable**: TOML configuration files and CLI options
+- **Extensible**: Plugin support for parser-specific extensions
+- **Well-tested**: Comprehensive test suite with TCK validation against CommonMark
+
+## Installation
+
+```bash
+# Using pip
+pip install md2typst
+
+# Using uv
+uv add md2typst
+```
+
+## Quick Start
+
+### Command Line
+
+```bash
+# Convert a file
+md2typst input.md -o output.typ
+
+# Convert from stdin
+echo "# Hello **World**" | md2typst
+
+# Use a specific parser
+md2typst --parser mistune input.md
+
+# List available parsers
+md2typst --list-parsers
+```
+
+### Python API
+
+```python
+from md2typst import convert
+
+# Simple conversion
+typst = convert("# Hello **World**")
+print(typst)
+# Output: = Hello *World*
+
+# With specific parser
+typst = convert("~~deleted~~", parser="mistune")
+print(typst)
+# Output: #strike[deleted]
+
+# With configuration
+from md2typst import convert_with_config
+from md2typst.config import Config
+
+config = Config(parser="marko", plugins=["gfm"])
+typst = convert_with_config("| A | B |\n|---|---|\n| 1 | 2 |", config)
+```
+
+## Supported Parsers
+
+| Parser | CLI Name | Description |
+|--------|----------|-------------|
+| [markdown-it-py](https://github.com/executablebooks/markdown-it-py) | `markdown-it` | Default. CommonMark compliant, extensible |
+| [mistune](https://github.com/lepture/mistune) | `mistune` | Fast, pure Python |
+| [marko](https://github.com/frostming/marko) | `marko` | CommonMark compliant, extensible |
+
+All parsers have GFM extensions (tables, strikethrough) enabled by default.
+
+## Markdown to Typst Mapping
+
+| Markdown | Typst |
+|----------|-------|
+| `# Heading` | `= Heading` |
+| `## Heading 2` | `== Heading 2` |
+| `*italic*` | `_italic_` |
+| `**bold**` | `*bold*` |
+| `~~strike~~` | `#strike[strike]` |
+| `` `code` `` | `` `code` `` |
+| `[text](url)` | `#link("url")[text]` |
+| `![alt](url)` | `#image("url", alt: "alt")` |
+| `> quote` | `#block(...)[quote]` |
+| `---` | `#line(length: 100%)` |
+| GFM tables | `#table(...)` |
+
+## Configuration
+
+Configuration is loaded from multiple sources (highest priority first):
+
+1. CLI arguments (`--parser`, `--plugin`)
+2. Explicit config file (`--config path/to/config.toml`)
+3. `.md2typst.toml` in the current or parent directories
+4. `[tool.md2typst]` section in `pyproject.toml`
+
+### Example Configuration
+
+**.md2typst.toml**:
+```toml
+parser = "mistune"
+plugins = ["strikethrough", "table"]
+
+[parser_options]
+html = true
+```
+
+**pyproject.toml**:
+```toml
+[tool.md2typst]
+parser = "markdown-it"
+plugins = ["gfm"]
+```
+
+### CLI Options
+
+```bash
+md2typst --help
+
+Options:
+  -o, --output FILE      Output file (default: stdout)
+  -p, --parser NAME      Parser to use (markdown-it, mistune, marko)
+  --plugin NAME          Load parser plugin (can be repeated)
+  --config FILE          Path to configuration file
+  --list-parsers         List available parsers
+  --show-config          Show effective configuration
+```
+
+## Development
+
+### Setup
+
+```bash
+git clone https://github.com/user/md2typst.git
+cd md2typst
+uv sync
+```
+
+### Running Tests
+
+```bash
+# Run all tests (benchmarks skipped by default)
+uv run pytest
+
+# Run by category
+uv run pytest -m unit          # Unit tests (fast)
+uv run pytest -m integration   # Integration tests
+uv run pytest -m e2e          # End-to-end tests
+uv run pytest -m benchmark    # Benchmark tests
+```
+
+### Test Structure
+
+```
+tests/
+├── a_unit/           # Unit tests (AST, generator)
+├── b_integration/    # Integration tests (parsers, config, TCK)
+├── c_e2e/           # End-to-end tests
+├── d_benchmark/     # Performance benchmarks
+└── fixtures/        # Test fixtures (CommonMark, GFM)
+```
+
+### Code Quality
+
+```bash
+# Type checking
+uv run mypy src/
+
+# Linting
+uv run ruff check src/
+
+# Formatting
+uv run ruff format src/
+```
+
+## Architecture
+
+```
+Markdown Input → Parser → AST → Generator → Typst Output
+```
+
+The converter uses a parser-agnostic AST (Abstract Syntax Tree) that decouples parsing from code generation. This allows:
+
+- Swapping parsers without changing the generator
+- Consistent output regardless of parser choice
+- Easy extension with new parsers
+
+## License
+
+MIT
+
+## Contributing
+
+Contributions are welcome! Please:
+
+1. Fork the repository
+2. Create a feature branch
+3. Add tests for new functionality
+4. Ensure all tests pass
+5. Submit a pull request

md2typst-0.1.0/pyproject.toml

@@ -0,0 +1,46 @@
+[project]
+name = "md2typst"
+version = "0.1.0"
+description = "Markdown to Typst converter with multiple parser support"
+readme = "README.md"
+authors = [
+    { name = "Stefane Fermigier", email = "sf@abilian.com" }
+]
+requires-python = ">=3.12"
+dependencies = [
+    "markdown-it-py>=3.0.0",
+    "click>=8.0.0",
+    "mistune>=3.0.0",
+    "marko>=2.0.0",
+]
+
+[project.scripts]
+md2typst = "md2typst:main"
+
+[dependency-groups]
+dev = [
+    "pytest>=8.0.0",
+    "pytest-cov>=4.0.0",
+    "pytest-benchmark>=4.0.0",
+    "hypothesis>=6.0.0",
+    "pyyaml>=6.0.0",
+    "ty>=0.0.8",
+    "pyrefly>=0.46.3",
+    "mypy>=1.19.1",
+]
+
+[build-system]
+requires = ["uv_build>=0.9.13,<0.10.0"]
+build-backend = "uv_build"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["src"]
+addopts = "-m 'not benchmark'"
+markers = [
+    "unit: Unit tests (fast, isolated)",
+    "integration: Integration tests (multiple components)",
+    "e2e: End-to-end tests (full workflow)",
+    "benchmark: Benchmark tests (slow, run with -m benchmark)",
+    "slow: Slow tests",
+]

md2typst-0.1.0/src/md2typst/__init__.py

@@ -0,0 +1,169 @@
+"""md2typst - Markdown to Typst converter."""
+
+from __future__ import annotations
+
+import contextlib
+from pathlib import Path
+from typing import Any
+
+from md2typst.ast import Document
+from md2typst.config import Config, load_config
+from md2typst.generator import TypstGenerator, generate_typst
+from md2typst.parsers import get_parser, list_parsers
+
+__version__ = "0.1.0"
+
+__all__ = [
+    "Config",
+    "Document",
+    "TypstGenerator",
+    "convert",
+    "convert_with_config",
+    "generate_typst",
+    "get_parser",
+    "list_parsers",
+    "main",
+]
+
+
+def convert(
+    markdown: str,
+    parser: str | None = None,
+    parser_options: dict[str, Any] | None = None,
+    plugins: list[str] | None = None,
+) -> str:
+    """Convert Markdown text to Typst.
+
+    Args:
+        markdown: The Markdown source text.
+        parser: Optional parser name. Uses default if not specified.
+        parser_options: Optional parser-specific options.
+        plugins: Optional list of parser plugins to load.
+
+    Returns:
+        The generated Typst source code.
+    """
+    p = get_parser(parser)
+
+    if parser_options:
+        p.configure(parser_options)
+
+    if plugins:
+        for plugin in plugins:
+            with contextlib.suppress(NotImplementedError):
+                p.load_plugin(plugin)
+
+    doc = p.parse(markdown)
+    return generate_typst(doc)
+
+
+def convert_with_config(markdown: str, config: Config) -> str:
+    """Convert Markdown text to Typst using a Config object.
+
+    Args:
+        markdown: The Markdown source text.
+        config: Configuration object.
+
+    Returns:
+        The generated Typst source code.
+    """
+    return convert(
+        markdown,
+        parser=config.parser,
+        parser_options=config.parser_options,
+        plugins=config.plugins,
+    )
+
+
+def main() -> None:
+    """CLI entry point."""
+    import sys
+
+    import click
+
+    @click.command()
+    @click.argument("input", type=click.Path(exists=True), required=False)
+    @click.option(
+        "-o", "--output", type=click.Path(), help="Output file (default: stdout)"
+    )
+    @click.option("-p", "--parser", default=None, help="Parser to use")
+    @click.option(
+        "-c",
+        "--config",
+        "config_file",
+        type=click.Path(exists=True),
+        help="Config file path",
+    )
+    @click.option(
+        "--plugin", multiple=True, help="Load parser plugin (can be repeated)"
+    )
+    @click.option("--list-parsers", is_flag=True, help="List available parsers")
+    @click.option("--show-config", is_flag=True, help="Show effective configuration")
+    @click.version_option(__version__)
+    def cli(
+        input: str | None,
+        output: str | None,
+        parser: str | None,
+        config_file: str | None,
+        plugin: tuple[str, ...],
+        list_parsers: bool,
+        show_config: bool,
+    ) -> None:
+        """Convert Markdown to Typst.
+
+        INPUT is the Markdown file to convert. Use - for stdin.
+        """
+        if list_parsers:
+            from md2typst.parsers import list_parsers as lp
+
+            click.echo("Available parsers:")
+            for name in lp():
+                click.echo(f"  - {name}")
+            return
+
+        # Determine start directory for config search
+        if input and input != "-":
+            start_dir = Path(input).parent
+        else:
+            start_dir = Path.cwd()
+
+        # Build CLI overrides
+        cli_overrides: dict[str, Any] = {}
+        if parser:
+            cli_overrides["parser"] = parser
+        if plugin:
+            cli_overrides["plugins"] = list(plugin)
+
+        # Load configuration
+        config = load_config(
+            config_file=Path(config_file) if config_file else None,
+            start_dir=start_dir,
+            cli_overrides=cli_overrides,
+        )
+
+        if show_config:
+            click.echo("Effective configuration:")
+            click.echo(f"  parser: {config.parser}")
+            click.echo(f"  plugins: {config.plugins}")
+            click.echo(f"  parser_options: {config.parser_options}")
+            click.echo(f"  output_options: {config.output_options}")
+            return
+
+        if input is None:
+            # Read from stdin
+            text = sys.stdin.read()
+        elif input == "-":
+            text = sys.stdin.read()
+        else:
+            with Path(input).open() as f:
+                text = f.read()
+
+        result = convert_with_config(text, config)
+
+        if output:
+            with Path(output).open("w") as f:
+                f.write(result)
+        else:
+            click.echo(result)
+
+    cli()