add python api

Author: folkertdev

.github/workflows/test.yml

@@ -34,3 +34,43 @@ jobs:
       - name: Run cargo nextest
         run: |
           cargo nextest run --profile ci --all-features
+
+  test-maturin-linux:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 2
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+
+      - name: Set up Rust
+        run: rustup show
+
+      - name: Install Maturin
+        run: pip install maturin
+
+      - name: Create and activate virtualenv
+        working-directory: "ziplinter-python"
+        run: |
+            python -m venv .venv
+            source .venv/bin/activate
+            pip install -U pip maturin
+            pip freeze
+
+      - name: Build the Python module
+        working-directory: "ziplinter-python"
+        run: |
+          source .venv/bin/activate
+          maturin develop
+
+      - name: Run test script
+        working-directory: "ziplinter-python"
+        run: |
+          source .venv/bin/activate
+          python test.py

Cargo.lock

@@ -1,6 +1,6 @@
 [workspace]
 resolver = "2"
-members = ["rc-zip-cli", "rc-zip", "rc-zip-sync", "rc-zip-tokio", "ziplinter"]
+members = ["rc-zip-cli", "rc-zip", "rc-zip-sync", "rc-zip-tokio", "ziplinter", "ziplinter-python"]
 exclude = ["fuzz"]
 
 # The profile that 'cargo dist' will build with

Cargo.toml

@@ -0,0 +1 @@
+.venv

ziplinter-python/.gitignore

@@ -0,0 +1,18 @@
+[package]
+name = "ziplinter-python"
+version = "0.1.0"
+edition = "2024"
+
+[lib]
+name = "ziplinter"
+crate-type = ["cdylib"]
+
+[dependencies]
+serde_json = "1.0.137"
+pythonize = "0.24.0"
+ziplinter = { version = "0.1.0", path = "../ziplinter" }
+
+[dependencies.pyo3]
+version = "0.24.0"
+# "abi3-py38" tells pyo3 (and maturin) to build using the stable ABI with minimum Python version 3.8
+features = ["abi3-py38"]

ziplinter-python/Cargo.toml

@@ -0,0 +1,7 @@
+[build-system]
+requires = ["maturin>=1.0,<2.0"]
+build-backend = "maturin"
+
+[tool.maturin]
+# "extension-module" tells pyo3 we want to build an extension module (skips linking against libpython.so)
+features = ["pyo3/extension-module"]

ziplinter-python/pyproject.toml

@@ -0,0 +1,24 @@
+use pyo3::prelude::*;
+use pythonize::pythonize;
+
+#[pyfunction]
+fn parse_file(py: Python, path: String) -> PyResult<pyo3::Bound<'_, PyAny>> {
+    let file = std::fs::File::open(&path)?;
+    let value = ::ziplinter::parse_file(&file);
+
+    Ok(pythonize(py, &value)?)
+}
+
+#[pyfunction]
+fn parse_bytes(py: Python, bytes: Vec<u8>) -> PyResult<pyo3::Bound<'_, PyAny>> {
+    let value = ::ziplinter::parse_bytes(&bytes);
+    Ok(pythonize(py, &value)?)
+}
+
+#[pymodule]
+fn ziplinter(m: &Bound<'_, PyModule>) -> PyResult<()> {
+    m.add_function(wrap_pyfunction!(parse_file, m)?)?;
+    m.add_function(wrap_pyfunction!(parse_bytes, m)?)?;
+
+    Ok(())
+}

ziplinter-python/src/lib.rs

@@ -0,0 +1,7 @@
+import ziplinter
+
+def main():
+    print("{}", ziplinter.parse_file("../testdata/unix.zip"))
+
+if __name__ == '__main__':
+    main()