comrak 0.0.3__tar.gz → 0.0.5__tar.gz

comrak-0.0.5/.aiignore

@@ -0,0 +1,9 @@
+.aiignore
+Cargo.lock
+target
+uv.lock
+.git
+.venv
+.ruff_cache
+dist
+LICENSE

{comrak-0.0.3 → comrak-0.0.5}/.gitignore

@@ -8,6 +8,8 @@ __pycache__/
 # C extensions
 *.so
 
+*.sw[op]
+
 # Distribution / packaging
 .Python
 .venv/

{comrak-0.0.3 → comrak-0.0.5}/Cargo.lock

@@ -234,6 +234,7 @@ dependencies = [
  "bon",
  "caseless",
  "clap",
+ "emojis",
  "entities",
  "memchr",
  "shell-words",
@@ -303,6 +304,15 @@ version = "1.6.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "339544cc9e2c4dc3fc7149fd630c5f22263a4fdf18a98afd0075784968b5cf00"
 
+[[package]]
+name = "emojis"
+version = "0.6.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "99e1f1df1f181f2539bac8bf027d31ca5ffbf9e559e3f2d09413b9107b5c02f4"
+dependencies = [
+ "phf",
+]
+
 [[package]]
 name = "entities"
 version = "1.0.1"
@@ -479,6 +489,24 @@ dependencies = [
  "pkg-config",
 ]
 
+[[package]]
+name = "phf"
+version = "0.11.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1fd6780a80ae0c52cc120a26a1a42c1ae51b247a253e4e06113d23d2c2edd078"
+dependencies = [
+ "phf_shared",
+]
+
+[[package]]
+name = "phf_shared"
+version = "0.11.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "67eabc2ef2a60eb7faa00097bd1ffdb5bd28e62bf39990626a582201b7a754e5"
+dependencies = [
+ "siphasher",
+]
+
 [[package]]
 name = "pkg-config"
 version = "0.3.31"
@@ -717,6 +745,12 @@ version = "1.3.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "0fda2ff0d084019ba4d7c6f371c95d8fd75ce3524c3cb8fb653a3023f6323e64"
 
+[[package]]
+name = "siphasher"
+version = "1.0.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "56199f7ddabf13fe5074ce809e7d3f42b42ae711800501b5b16ea82ad029c39d"
+
 [[package]]
 name = "slug"
 version = "0.1.6"

{comrak-0.0.3 → comrak-0.0.5}/Cargo.toml

@@ -1,5 +1,5 @@
 [dependencies]
-comrak_lib = {package = "comrak", version = "0.35.0"}
+comrak_lib = {package = "comrak", version = "0.35.0", features = ["shortcodes"]}
 pyo3 = "0.23.3"
 
 [lib]

comrak-0.0.5/DEVELOPMENT.md

@@ -0,0 +1,7 @@
+## Release process
+
+- `pre-commit run all-files`
+- `maturin develop --release`
+- `git push`
+- `gh run download -p wheel*`
+- `mv wheel*/* dist/ && rm -rf wheel* && pdm publish --no-build`

{comrak-0.0.3 → comrak-0.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: comrak
-Version: 0.0.3
+Version: 0.0.5
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Rust
@@ -14,6 +14,8 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.9
 Requires-Dist: maturin[patchelf]>=1.8.2 ; extra == 'dev'
+Requires-Dist: pdm>=2.22.3 ; extra == 'dev'
+Requires-Dist: pdm-bump>=0.9.10 ; extra == 'dev'
 Requires-Dist: pre-commit>=4.1.0 ; extra == 'dev'
 Requires-Dist: markdown>=3.7 ; extra == 'bench'
 Requires-Dist: markdown2>=2.5.3 ; extra == 'bench'
@@ -54,6 +56,22 @@ pip install comrak
 
 Fast Markdown to HTML parser in Rust, shipped for Python via PyO3.
 
+### Options
+
+All options are exposed in a simple manner:
+
+```py
+>>> import comrak
+>>> opts = comrak.ExtensionOptions()
+>>> comrak.render_markdown("foo :smile:", extension_options=opts)
+'<p>foo :smile:</p>\n'
+>>> opts.shortcodes = True
+>>> comrak.render_markdown("foo :smile:", extension_options=opts)
+'<p>foo 😄</p>\n'
+```
+
+Refer to the [Comrak docs](https://docs.rs/comrak/latest/comrak/struct.Options.html) for all available options.
+
 ## Benchmarks
 
 Tested with small (8 lines) and medium (1200 lines) markdown strings
@@ -73,5 +91,5 @@ Maintained by [lmmx](https://github.com/lmmx). Contributions welcome!
 
 ## License
 
-This project is licensed under the [MIT License](https://opensource.org/licenses/MIT).
+Licensed under the 2-Clause BSD License. See [LICENSE](https://github.com/lmmx/comrak/blob/master/LICENSE) for all the details.
 

{comrak-0.0.3 → comrak-0.0.5}/README.md

@@ -24,6 +24,22 @@ pip install comrak
 
 Fast Markdown to HTML parser in Rust, shipped for Python via PyO3.
 
+### Options
+
+All options are exposed in a simple manner:
+
+```py
+>>> import comrak
+>>> opts = comrak.ExtensionOptions()
+>>> comrak.render_markdown("foo :smile:", extension_options=opts)
+'<p>foo :smile:</p>\n'
+>>> opts.shortcodes = True
+>>> comrak.render_markdown("foo :smile:", extension_options=opts)
+'<p>foo 😄</p>\n'
+```
+
+Refer to the [Comrak docs](https://docs.rs/comrak/latest/comrak/struct.Options.html) for all available options.
+
 ## Benchmarks
 
 Tested with small (8 lines) and medium (1200 lines) markdown strings
@@ -43,4 +59,4 @@ Maintained by [lmmx](https://github.com/lmmx). Contributions welcome!
 
 ## License
 
-This project is licensed under the [MIT License](https://opensource.org/licenses/MIT).
+Licensed under the 2-Clause BSD License. See [LICENSE](https://github.com/lmmx/comrak/blob/master/LICENSE) for all the details.

{comrak-0.0.3 → comrak-0.0.5}/pyproject.toml

@@ -21,9 +21,6 @@ classifiers = [
   "Programming Language :: Python :: 3.13",
   "Programming Language :: Python :: 3.9"
 ]
-dynamic = [
-  "version"
-]
 authors = [
   {email = "louismmx@gmail.com", name = "Louis Maddox"}
 ]
@@ -37,7 +34,7 @@ keywords = [
 ]
 readme = "README.md"
 requires-python = ">=3.9"
-version = "0.0.3"
+version = "0.0.5"
 
 [project.license]
 file = "LICENSE"
@@ -45,7 +42,9 @@ file = "LICENSE"
 [project.optional-dependencies]
 dev = [
   "maturin[patchelf]>=1.8.2",
-  "pre-commit>=4.1.0"
+  "pdm>=2.22.3",
+  "pdm-bump>=0.9.10",
+  "pre-commit>=4.1.0",
 ]
 bench = [
   "markdown>=3.7",

comrak-0.0.5/src/lib.rs

@@ -0,0 +1,48 @@
+use pyo3::prelude::*;
+
+// We renamed the Rust library to `comrak_lib`
+use comrak_lib::{markdown_to_html, Options as ComrakOptions};
+
+// Import the Python option classes we defined
+mod options;
+use options::{PyExtensionOptions, PyParseOptions, PyRenderOptions};
+
+/// Render a Markdown string to HTML, with optional Extension/Parse/Render overrides.
+#[pyfunction(signature=(text, extension_options=None, parse_options=None, render_options=None))]
+fn render_markdown(
+    text: &str,
+    extension_options: Option<PyExtensionOptions>,
+    parse_options: Option<PyParseOptions>,
+    render_options: Option<PyRenderOptions>,
+) -> PyResult<String> {
+    let mut opts = ComrakOptions::default();
+
+    // If user provided custom extension options, apply them.
+    if let Some(py_ext) = extension_options {
+        py_ext.update_extension_options(&mut opts.extension);
+    }
+
+    if let Some(py_parse) = parse_options {
+        py_parse.update_parse_options(&mut opts.parse);
+    }
+
+    if let Some(py_render) = render_options {
+        py_render.update_render_options(&mut opts.render);
+    }
+
+    let html = markdown_to_html(text, &opts);
+    Ok(html)
+}
+
+#[pymodule]
+fn comrak(m: &Bound<'_, PyModule>) -> PyResult<()> {
+    // Expose the function
+    m.add_function(wrap_pyfunction!(render_markdown, m)?)?;
+
+    // Expose the classes
+    m.add_class::<PyExtensionOptions>()?;
+    m.add_class::<PyParseOptions>()?;
+    m.add_class::<PyRenderOptions>()?;
+
+    Ok(())
+}

comrak-0.0.5/src/options.rs

@@ -0,0 +1,246 @@
+use pyo3::prelude::*;
+
+// Import the Comrak (Rust) types under `comrak_lib::`
+use comrak_lib::{
+    ExtensionOptions as ComrakExtensionOptions, ListStyleType, ParseOptions as ComrakParseOptions,
+    RenderOptions as ComrakRenderOptions,
+};
+
+/// Python class that mirrors Comrak’s `ExtensionOptions`
+#[pyclass(name = "ExtensionOptions")]
+#[derive(Clone)]
+pub struct PyExtensionOptions {
+    #[pyo3(get, set)]
+    pub strikethrough: bool,
+    #[pyo3(get, set)]
+    pub tagfilter: bool,
+    #[pyo3(get, set)]
+    pub table: bool,
+    #[pyo3(get, set)]
+    pub autolink: bool,
+    #[pyo3(get, set)]
+    pub tasklist: bool,
+    #[pyo3(get, set)]
+    pub superscript: bool,
+    #[pyo3(get, set)]
+    pub header_ids: Option<String>,
+    #[pyo3(get, set)]
+    pub footnotes: bool,
+    #[pyo3(get, set)]
+    pub description_lists: bool,
+    #[pyo3(get, set)]
+    pub front_matter_delimiter: Option<String>,
+    #[pyo3(get, set)]
+    pub multiline_block_quotes: bool,
+    #[pyo3(get, set)]
+    pub alerts: bool,
+    #[pyo3(get, set)]
+    pub math_dollars: bool,
+    #[pyo3(get, set)]
+    pub math_code: bool,
+    #[pyo3(get, set)]
+    pub shortcodes: bool, // if your comrak_lib has the "shortcodes" feature
+    #[pyo3(get, set)]
+    pub wikilinks_title_after_pipe: bool,
+    #[pyo3(get, set)]
+    pub wikilinks_title_before_pipe: bool,
+    #[pyo3(get, set)]
+    pub underline: bool,
+    #[pyo3(get, set)]
+    pub subscript: bool,
+    #[pyo3(get, set)]
+    pub spoiler: bool,
+    #[pyo3(get, set)]
+    pub greentext: bool,
+}
+
+impl PyExtensionOptions {
+    /// **Rust-only** helper to copy from `PyExtensionOptions` into a real `ComrakExtensionOptions`.
+    pub fn update_extension_options(&self, opts: &mut ComrakExtensionOptions<'_>) {
+        opts.strikethrough = self.strikethrough;
+        opts.tagfilter = self.tagfilter;
+        opts.table = self.table;
+        opts.autolink = self.autolink;
+        opts.tasklist = self.tasklist;
+        opts.superscript = self.superscript;
+        opts.header_ids = self.header_ids.clone();
+        opts.footnotes = self.footnotes;
+        opts.description_lists = self.description_lists;
+        opts.front_matter_delimiter = self.front_matter_delimiter.clone();
+        opts.multiline_block_quotes = self.multiline_block_quotes;
+        opts.alerts = self.alerts;
+        opts.math_dollars = self.math_dollars;
+        opts.math_code = self.math_code;
+        opts.shortcodes = self.shortcodes;
+        opts.wikilinks_title_after_pipe = self.wikilinks_title_after_pipe;
+        opts.wikilinks_title_before_pipe = self.wikilinks_title_before_pipe;
+        opts.underline = self.underline;
+        opts.subscript = self.subscript;
+        opts.spoiler = self.spoiler;
+        opts.greentext = self.greentext;
+    }
+}
+
+#[pymethods]
+impl PyExtensionOptions {
+    #[new]
+    pub fn new() -> Self {
+        let defaults = ComrakExtensionOptions::default();
+        Self {
+            strikethrough: defaults.strikethrough,
+            tagfilter: defaults.tagfilter,
+            table: defaults.table,
+            autolink: defaults.autolink,
+            tasklist: defaults.tasklist,
+            superscript: defaults.superscript,
+            header_ids: defaults.header_ids.clone(),
+            footnotes: defaults.footnotes,
+            description_lists: defaults.description_lists,
+            front_matter_delimiter: defaults.front_matter_delimiter.clone(),
+            multiline_block_quotes: defaults.multiline_block_quotes,
+            alerts: defaults.alerts,
+            math_dollars: defaults.math_dollars,
+            math_code: defaults.math_code,
+            shortcodes: false, // or `defaults.shortcodes` if your version has that
+            wikilinks_title_after_pipe: defaults.wikilinks_title_after_pipe,
+            wikilinks_title_before_pipe: defaults.wikilinks_title_before_pipe,
+            underline: defaults.underline,
+            subscript: defaults.subscript,
+            spoiler: defaults.spoiler,
+            greentext: defaults.greentext,
+        }
+    }
+}
+
+/// Python class that mirrors Comrak’s `ParseOptions`
+#[pyclass(name = "ParseOptions")]
+#[derive(Clone)]
+pub struct PyParseOptions {
+    #[pyo3(get, set)]
+    pub smart: bool,
+    #[pyo3(get, set)]
+    pub default_info_string: Option<String>,
+    #[pyo3(get, set)]
+    pub relaxed_tasklist_matching: bool,
+    #[pyo3(get, set)]
+    pub relaxed_autolinks: bool,
+}
+
+impl PyParseOptions {
+    /// Rust-only helper
+    pub fn update_parse_options(&self, opts: &mut ComrakParseOptions<'_>) {
+        opts.smart = self.smart;
+        opts.default_info_string = self.default_info_string.clone();
+        opts.relaxed_tasklist_matching = self.relaxed_tasklist_matching;
+        opts.relaxed_autolinks = self.relaxed_autolinks;
+    }
+}
+
+#[pymethods]
+impl PyParseOptions {
+    #[new]
+    pub fn new() -> Self {
+        let defaults = ComrakParseOptions::default();
+        Self {
+            smart: defaults.smart,
+            default_info_string: defaults.default_info_string.clone(),
+            relaxed_tasklist_matching: defaults.relaxed_tasklist_matching,
+            relaxed_autolinks: defaults.relaxed_autolinks,
+        }
+    }
+}
+
+/// Python class that mirrors Comrak’s `RenderOptions`
+#[pyclass(name = "RenderOptions")]
+#[derive(Clone)]
+pub struct PyRenderOptions {
+    #[pyo3(get, set)]
+    pub hardbreaks: bool,
+    #[pyo3(get, set)]
+    pub github_pre_lang: bool,
+    #[pyo3(get, set)]
+    pub full_info_string: bool,
+    #[pyo3(get, set)]
+    pub width: usize,
+    #[pyo3(get, set)]
+    pub unsafe_: bool, // named 'unsafe_' because 'unsafe' is reserved
+    #[pyo3(get, set)]
+    pub escape: bool,
+    #[pyo3(get, set)]
+    pub list_style: u8, // store 42 = '*', 43 = '+', 45 = '-'
+    #[pyo3(get, set)]
+    pub sourcepos: bool,
+    #[pyo3(get, set)]
+    pub experimental_inline_sourcepos: bool,
+    #[pyo3(get, set)]
+    pub escaped_char_spans: bool,
+    #[pyo3(get, set)]
+    pub ignore_setext: bool,
+    #[pyo3(get, set)]
+    pub ignore_empty_links: bool,
+    #[pyo3(get, set)]
+    pub gfm_quirks: bool,
+    #[pyo3(get, set)]
+    pub prefer_fenced: bool,
+    #[pyo3(get, set)]
+    pub figure_with_caption: bool,
+    #[pyo3(get, set)]
+    pub tasklist_classes: bool,
+    #[pyo3(get, set)]
+    pub ol_width: usize,
+}
+
+impl PyRenderOptions {
+    /// Rust-only helper
+    pub fn update_render_options(&self, opts: &mut ComrakRenderOptions) {
+        opts.hardbreaks = self.hardbreaks;
+        opts.github_pre_lang = self.github_pre_lang;
+        opts.full_info_string = self.full_info_string;
+        opts.width = self.width;
+        opts.unsafe_ = self.unsafe_;
+        opts.escape = self.escape;
+        // convert integer to ListStyleType
+        opts.list_style = match self.list_style {
+            43 => ListStyleType::Plus, // '+'
+            42 => ListStyleType::Star, // '*'
+            _ => ListStyleType::Dash,  // '-'
+        };
+        opts.sourcepos = self.sourcepos;
+        opts.experimental_inline_sourcepos = self.experimental_inline_sourcepos;
+        opts.escaped_char_spans = self.escaped_char_spans;
+        opts.ignore_setext = self.ignore_setext;
+        opts.ignore_empty_links = self.ignore_empty_links;
+        opts.gfm_quirks = self.gfm_quirks;
+        opts.prefer_fenced = self.prefer_fenced;
+        opts.figure_with_caption = self.figure_with_caption;
+        opts.tasklist_classes = self.tasklist_classes;
+        opts.ol_width = self.ol_width;
+    }
+}
+
+#[pymethods]
+impl PyRenderOptions {
+    #[new]
+    pub fn new() -> Self {
+        let defaults = ComrakRenderOptions::default();
+        Self {
+            hardbreaks: defaults.hardbreaks,
+            github_pre_lang: defaults.github_pre_lang,
+            full_info_string: defaults.full_info_string,
+            width: defaults.width,
+            unsafe_: defaults.unsafe_,
+            escape: defaults.escape,
+            list_style: defaults.list_style as u8, // 45 if dash
+            sourcepos: defaults.sourcepos,
+            experimental_inline_sourcepos: defaults.experimental_inline_sourcepos,
+            escaped_char_spans: defaults.escaped_char_spans,
+            ignore_setext: defaults.ignore_setext,
+            ignore_empty_links: defaults.ignore_empty_links,
+            gfm_quirks: defaults.gfm_quirks,
+            prefer_fenced: defaults.prefer_fenced,
+            figure_with_caption: defaults.figure_with_caption,
+            tasklist_classes: defaults.tasklist_classes,
+            ol_width: defaults.ol_width,
+        }
+    }
+}