Merge pull request #12 from django-components/jo-monorepo

Author: JuroOravec

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Release notes
 
+## v1.1.0
+
+- Renamed package from `djc-core-html-parser` to `djc-core`
+- Refactored project into a monorepo
+
 ## v1.0.3
 
 - Update to Python 3.14

Cargo.lock

@@ -1,14 +1,11 @@
-[package]
-name = "djc_core_html_parser"
-version = "1.0.3"
-edition = "2021"
+[workspace]
+members = [
+    "crates/djc-core",
+    "crates/djc-html-transformer",
+]
+resolver = "2"
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-[lib]
-name = "djc_core_html_parser"
-crate-type = ["cdylib"]
-
-[dependencies]
+[workspace.dependencies]
 pyo3 = { version = "0.27.0", features = ["extension-module"] }
 quick-xml = "0.38.3"
 

Cargo.toml

@@ -1,21 +1,27 @@
-# djc-core-html-parser
+# djc-core
 
-[![PyPI - Version](https://img.shields.io/pypi/v/djc-core-html-parser)](https://pypi.org/project/djc-core-html-parser/) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/djc-core-html-parser)](https://pypi.org/project/djc-core-html-parser/) [![PyPI - License](https://img.shields.io/pypi/l/djc-core-html-parser)](https://github.com/django-components/djc-core-html-parser/blob/master/LICENSE/) [![PyPI - Downloads](https://img.shields.io/pypi/dm/djc-core-html-parser)](https://pypistats.org/packages/djc-core-html-parser) [![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/django-components/djc-core-html-parser/tests.yml)](https://github.com/django-components/djc-core-html-parser/actions/workflows/tests.yml)
+[![PyPI - Version](https://img.shields.io/pypi/v/djc-core)](https://pypi.org/project/djc-core/) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/djc-core)](https://pypi.org/project/djc-core/) [![PyPI - License](https://img.shields.io/pypi/l/djc-core)](https://github.com/django-components/djc-core/blob/master/LICENSE/) [![PyPI - Downloads](https://img.shields.io/pypi/dm/djc-core)](https://pypistats.org/packages/djc-core) [![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/django-components/djc-core/tests.yml)](https://github.com/django-components/djc-core/actions/workflows/tests.yml)
 
-HTML parser used by [django-components](https://github.com/django-components/django-components). Written in Rust, exposed as a Python package with [maturin](https://www.maturin.rs/).
-
-This implementation was found to be 40-50x faster than our Python implementation, taking ~90ms to parse 5 MB of HTML.
+Rust-based parsers and toolings used by [django-components](https://github.com/django-components/django-components). Exposed as a Python package with [maturin](https://www.maturin.rs/).
 
 ## Installation
 
 ```sh
-pip install djc-core-html-parser
+pip install djc-core
 ```
 
-## Usage
+## Packages
+
+### HTML transfomer
+
+Transform HTML in a single pass. This is a simple implementation.
+
+This implementation was found to be 40-50x faster than our Python implementation, taking ~90ms to parse 5 MB of HTML.
+
+**Usage**
 
 ```python
-from djc_core_html_parser import set_html_attributes
+from djc_core import set_html_attributes
 
 html = '<div><p>Hello</p></div>'
 result, _ = set_html_attributes(
@@ -39,7 +45,7 @@ Then, during the HTML transformation, we check each element for this attribute.
 2. Record the attributes that were added to the element, using the value of the watched attribute as the key.
 
 ```python
-from djc_core_html_parser import set_html_attributes
+from djc_core import set_html_attributes
 
 html = """
   <div data-watch-id="123">
@@ -117,4 +123,4 @@ To publish a new version of the package, you need to:
 
 1. Bump the version in `pyproject.toml` and `Cargo.toml`
 2. Open a PR and merge it to `main`.
-3. Create a new tag on the `main` branch with the new version number (e.g. `v1.0.0`), or create a new release in the GitHub UI.
+3. Create a new tag on the `main` branch with the new version number (e.g. `1.0.0`), or create a new release in the GitHub UI.

README.md

@@ -0,0 +1,14 @@
+[package]
+name = "djc-core"
+version = "1.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+[lib]
+name = "djc_core"
+crate-type = ["cdylib"]
+
+[dependencies]
+djc-html-transformer = { path = "../djc-html-transformer" }
+pyo3 = { workspace = true }
+quick-xml = { workspace = true }

crates/djc-core/Cargo.toml

@@ -0,0 +1,9 @@
+use djc_html_transformer::set_html_attributes;
+use pyo3::prelude::*;
+
+/// A Python module implemented in Rust for high-performance transformations.
+#[pymodule]
+fn djc_core(m: &Bound<'_, PyModule>) -> PyResult<()> {
+    m.add_function(wrap_pyfunction!(set_html_attributes, m)?)?;
+    Ok(())
+}

crates/djc-core/src/lib.rs

@@ -0,0 +1,8 @@
+[package]
+name = "djc-html-transformer"
+version = "1.0.3"
+edition = "2021"
+
+[dependencies]
+pyo3 = { workspace = true }
+quick-xml = { workspace = true }

crates/djc-html-transformer/Cargo.toml

@@ -2,8 +2,8 @@
 # This file is what maturin auto-generates. But it seems maturin omits it when we have a __init__.pyi file.
 # So we have to manually include it here.
 
-from .djc_core_html_parser import *
+from .djc_core import *
 
-__doc__ = djc_core_html_parser.__doc__
-if hasattr(djc_core_html_parser, "__all__"):
-    __all__ = djc_core_html_parser.__all__
+__doc__ = djc_core.__doc__
+if hasattr(djc_core, "__all__"):
+    __all__ = djc_core.__all__