ducpy 3.3.7__tar.gz → 3.4.0__tar.gz

{ducpy-3.3.7 → ducpy-3.4.0}/Cargo.lock

@@ -412,7 +412,7 @@ dependencies = [
 
 [[package]]
 name = "ducpy-native"
-version = "3.3.7"
+version = "3.4.0"
 dependencies = [
  "duc",
  "pyo3",

ducpy-3.4.0/PKG-INFO

@@ -0,0 +1,104 @@
+Metadata-Version: 2.4
+Name: ducpy
+Version: 3.4.0
+Classifier: License :: OSI Approved :: MIT License
+Requires-Dist: nanoid>=2.0.0
+License-File: LICENSE
+Summary: The library for the Duc 2D CAD file format
+Author: Jorge Soares
+Author-email: Ducflair <support@ducflair.com>
+License: MIT
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Documentation, https://ducflair.github.io/duc/reference/python/
+Project-URL: Homepage, https://duc.ducflair.com
+Project-URL: Package Index, https://ducflair.github.io/duc/simple/ducpy/
+Project-URL: Source, https://github.com/ducflair/duc/tree/main/packages/ducpy
+
+# ducpy
+
+<p align="center">
+  <br/>
+  <a href="https://duc.ducflair.com" target="_blank"><img width="256px" src="https://cdn.jsdelivr.net/gh/ducflair/assets@main/src/duc/duc-extended.png" /></a>
+  <p align="center">2D CAD File Format</p>
+  <p align="center" style="align: center;">
+    <a href="https://pypi.org/project/ducpy/"><img src="https://shields.io/badge/Pip-blue?logo=Pypi&logoColor=white&style=round-square" alt="Pip" /></a>
+    <a href="https://github.com/ducflair/duc/releases"><img src="https://img.shields.io/pypi/v/ducpy?style=round-square&label=latest%20stable" alt="PyPI ducpy@latest release" /></a>
+    <a href="https://pypi.org/project/ducpy/"><img src="https://img.shields.io/pypi/dm/ducpy?style=round-square&color=salmon" alt="Downloads" /></a>
+    <img src="https://shields.io/badge/Python-ffde57?logo=Python&logoColor=646464&style=round-square" alt="Python" />
+  </p>
+</p>
+
+The `ducpy` package is the official Python implementation of the `.duc` 2D CAD file format. It is built on top of the [`duc`](../ducrs) Rust crate, exposed as the `ducpy_native` extension. A `.duc` file is a zlib-compressed SQLite database — `ducpy` gives you both a high-level builder DSL and direct low-level access to that schema, plus parsing, serialization, and search helpers.
+
+## Installation
+
+```bash
+pip install ducpy
+```
+
+or with [`uv`](https://docs.astral.sh/uv/):
+
+```bash
+uv add ducpy
+```
+
+## Quick start
+
+```python
+import ducpy as duc
+```
+
+## API overview
+
+`ducpy` is organised around four conceptual entry points, matching the structure of the full [API reference](https://duc.ducflair.com):
+
+### Builders API (High-level)
+
+The easy way to build and manage `.duc` files. Construct elements, apply styles, manage layers, build blocks, and handle document state through the `duc.builders` module.
+
+See the worked examples:
+
+- [Element creation](src/examples/element_creation_demo.py) — building rectangles, ellipses, polygons, lines, arrows, text, frames and plots with the fluent builder DSL.
+- [Mutating elements](src/examples/mutation_demo.py) — updating element properties in place and observing version changes.
+- [Document elements](src/examples/document_element_demo.py) and [model elements](src/examples/model_element_demo.py) — for the higher-level container / model element types.
+
+### SQL Builder (Low-level)
+
+A `.duc` file is a zlib-compressed SQLite database. Use `duc.builders.sql_builder` (`DucSQL`) for direct schema access, bulk queries, and low-level manipulation.
+
+See the worked example: [SQL Builder](src/examples/sql_builder_demo.py) — `DucSQL.new()` to create a `.duc` from scratch, `DucSQL(path)` to query an existing one.
+
+### Search
+
+Query and search elements and files programmatically through the `duc.search` API.
+
+### File I/O
+
+Read and write `.duc` files using the `duc.parse` and `duc.serialize` modules.
+
+See the worked examples:
+
+- [Parsing](src/examples/parsing_demo.py) — `parse_duc` / `parse_duc_lazy` / `get_external_file` / `list_external_files`.
+- [Serialization](src/examples/serialization_demo.py) — `serialize_duc` from builder-created elements.
+- [External files](src/examples/external_files_demo.py) — attaching binary blobs (images, PDFs) to a `.duc` document.
+
+## Documentation
+
+For detailed documentation, including the full API reference, schema specification, and end-to-end examples, see:
+
+- API reference & guides: [duc.ducflair.com](https://duc.ducflair.com)
+- Source-level reference: [docs/](docs/index.rst)
+- Full example index: [docs/examples.rst](docs/examples.rst)
+
+## Tools
+
+- [Playground](https://scopture.com): Experiment with the `duc` format in a live environment.
+
+## Contributing
+
+Feel free to open an issue or contact us at [Ducflair Support](https://www.ducflair.com/support).
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for more details.

ducpy-3.4.0/README.md

@@ -0,0 +1,87 @@
+# ducpy
+
+<p align="center">
+  <br/>
+  <a href="https://duc.ducflair.com" target="_blank"><img width="256px" src="https://cdn.jsdelivr.net/gh/ducflair/assets@main/src/duc/duc-extended.png" /></a>
+  <p align="center">2D CAD File Format</p>
+  <p align="center" style="align: center;">
+    <a href="https://pypi.org/project/ducpy/"><img src="https://shields.io/badge/Pip-blue?logo=Pypi&logoColor=white&style=round-square" alt="Pip" /></a>
+    <a href="https://github.com/ducflair/duc/releases"><img src="https://img.shields.io/pypi/v/ducpy?style=round-square&label=latest%20stable" alt="PyPI ducpy@latest release" /></a>
+    <a href="https://pypi.org/project/ducpy/"><img src="https://img.shields.io/pypi/dm/ducpy?style=round-square&color=salmon" alt="Downloads" /></a>
+    <img src="https://shields.io/badge/Python-ffde57?logo=Python&logoColor=646464&style=round-square" alt="Python" />
+  </p>
+</p>
+
+The `ducpy` package is the official Python implementation of the `.duc` 2D CAD file format. It is built on top of the [`duc`](../ducrs) Rust crate, exposed as the `ducpy_native` extension. A `.duc` file is a zlib-compressed SQLite database — `ducpy` gives you both a high-level builder DSL and direct low-level access to that schema, plus parsing, serialization, and search helpers.
+
+## Installation
+
+```bash
+pip install ducpy
+```
+
+or with [`uv`](https://docs.astral.sh/uv/):
+
+```bash
+uv add ducpy
+```
+
+## Quick start
+
+```python
+import ducpy as duc
+```
+
+## API overview
+
+`ducpy` is organised around four conceptual entry points, matching the structure of the full [API reference](https://duc.ducflair.com):
+
+### Builders API (High-level)
+
+The easy way to build and manage `.duc` files. Construct elements, apply styles, manage layers, build blocks, and handle document state through the `duc.builders` module.
+
+See the worked examples:
+
+- [Element creation](src/examples/element_creation_demo.py) — building rectangles, ellipses, polygons, lines, arrows, text, frames and plots with the fluent builder DSL.
+- [Mutating elements](src/examples/mutation_demo.py) — updating element properties in place and observing version changes.
+- [Document elements](src/examples/document_element_demo.py) and [model elements](src/examples/model_element_demo.py) — for the higher-level container / model element types.
+
+### SQL Builder (Low-level)
+
+A `.duc` file is a zlib-compressed SQLite database. Use `duc.builders.sql_builder` (`DucSQL`) for direct schema access, bulk queries, and low-level manipulation.
+
+See the worked example: [SQL Builder](src/examples/sql_builder_demo.py) — `DucSQL.new()` to create a `.duc` from scratch, `DucSQL(path)` to query an existing one.
+
+### Search
+
+Query and search elements and files programmatically through the `duc.search` API.
+
+### File I/O
+
+Read and write `.duc` files using the `duc.parse` and `duc.serialize` modules.
+
+See the worked examples:
+
+- [Parsing](src/examples/parsing_demo.py) — `parse_duc` / `parse_duc_lazy` / `get_external_file` / `list_external_files`.
+- [Serialization](src/examples/serialization_demo.py) — `serialize_duc` from builder-created elements.
+- [External files](src/examples/external_files_demo.py) — attaching binary blobs (images, PDFs) to a `.duc` document.
+
+## Documentation
+
+For detailed documentation, including the full API reference, schema specification, and end-to-end examples, see:
+
+- API reference & guides: [duc.ducflair.com](https://duc.ducflair.com)
+- Source-level reference: [docs/](docs/index.rst)
+- Full example index: [docs/examples.rst](docs/examples.rst)
+
+## Tools
+
+- [Playground](https://scopture.com): Experiment with the `duc` format in a live environment.
+
+## Contributing
+
+Feel free to open an issue or contact us at [Ducflair Support](https://www.ducflair.com/support).
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for more details.

{ducpy-3.3.7 → ducpy-3.4.0}/packages/ducpy/crate/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "ducpy-native"
-version = "3.3.7"
+version = "3.4.0"
 edition = "2021"
 description = "Python native extension for the duc file format (used by ducpy)"
 publish = false

{ducpy-3.3.7 → ducpy-3.4.0}/packages/ducpy/crate/src/lib.rs

@@ -58,6 +58,45 @@ fn list_external_files(py: Python<'_>, buf: &[u8]) -> PyResult<PyObject> {
         .map_err(|e| pyo3::exceptions::PyValueError::new_err(format!("{e}")))
 }
 
+/// Returns the current DUC schema version as a semver string (e.g. "3.0.0").
+#[pyfunction]
+fn get_schema_version() -> PyResult<String> {
+    Ok(duc::db::bootstrap::CURRENT_SCHEMA_VERSION_SEMVER.into())
+}
+
+/// Returns the raw integer schema version (e.g. 3000000).
+#[pyfunction]
+fn get_schema_version_int() -> PyResult<i64> {
+    Ok(duc::db::bootstrap::current_schema_version_int())
+}
+
+/// Returns the canonical `duc.sql` schema string.
+#[pyfunction]
+fn get_duc_schema_sql() -> PyResult<String> {
+    Ok(duc::db::bootstrap::DUC_SCHEMA_SQL.into())
+}
+
+/// Returns the `version_control.sql` schema string.
+#[pyfunction]
+fn get_version_control_schema_sql() -> PyResult<String> {
+    Ok(duc::db::bootstrap::VERSION_CONTROL_SCHEMA_SQL.into())
+}
+
+/// Returns the `search.sql` schema string.
+#[pyfunction]
+fn get_search_schema_sql() -> PyResult<String> {
+    Ok(duc::db::bootstrap::SEARCH_SCHEMA_SQL.into())
+}
+
+/// Returns all migrations as a list of `(from_version, to_version, sql)` tuples.
+#[pyfunction]
+fn get_migrations(_py: Python<'_>) -> PyResult<Vec<(i64, i64, String)>> {
+    Ok(duc::db::bootstrap::MIGRATIONS
+        .iter()
+        .map(|(f, t, sql)| (*f, *t, sql.to_string()))
+        .collect())
+}
+
 /// Native duc file format operations.
 #[pymodule]
 fn ducpy_native(m: &Bound<'_, PyModule>) -> PyResult<()> {
@@ -66,5 +105,11 @@ fn ducpy_native(m: &Bound<'_, PyModule>) -> PyResult<()> {
     m.add_function(wrap_pyfunction!(serialize_duc, m)?)?;
     m.add_function(wrap_pyfunction!(get_external_file, m)?)?;
     m.add_function(wrap_pyfunction!(list_external_files, m)?)?;
+    m.add_function(wrap_pyfunction!(get_schema_version, m)?)?;
+    m.add_function(wrap_pyfunction!(get_schema_version_int, m)?)?;
+    m.add_function(wrap_pyfunction!(get_duc_schema_sql, m)?)?;
+    m.add_function(wrap_pyfunction!(get_version_control_schema_sql, m)?)?;
+    m.add_function(wrap_pyfunction!(get_search_schema_sql, m)?)?;
+    m.add_function(wrap_pyfunction!(get_migrations, m)?)?;
     Ok(())
 }

{ducpy-3.3.7 → ducpy-3.4.0}/packages/ducrs/Cargo.toml

@@ -13,9 +13,7 @@ include = [
   "Cargo.toml",
   "README.md",
   "LICENSE",
-  "schema/duc.sql",
-  "schema/version_control.sql",
-  "schema/search.sql",
+  "schema/*.sql",
   "schema/migrations/*.sql",
 ]
 

ducpy-3.4.0/packages/ducrs/README.md

@@ -0,0 +1,54 @@
+# duc (Rust)
+
+<p align="center">
+  <br/>
+  <a href="https://duc.ducflair.com" target="_blank"><img width="256px" src="https://cdn.jsdelivr.net/gh/ducflair/assets@main/src/duc/duc-extended.png" /></a>
+  <p align="center">2D CAD File Format</p>
+  <p align="center" style="align: center;">
+    <a href="https://crates.io/crates/duc"><img src="https://shields.io/badge/Crates-FFC933?logo=Rust&logoColor=646464&style=round-square" alt="Crates" /></a>
+    <a href="https://github.com/ducflair/duc/releases"><img src="https://img.shields.io/crates/v/duc?style=round-square&label=latest%20stable" alt="crates.io duc@latest release" /></a>
+    <a href="https://crates.io/crates/duc"><img src="https://img.shields.io/crates/d/duc?style=round-square&color=salmon" alt="Downloads" /></a>
+    <img src="https://shields.io/badge/Rust-CE412B?logo=Rust&logoColor=fff&style=round-square" alt="Rust" />
+  </p>
+</p>
+
+The `duc` crate is the canonical Rust implementation of the `.duc` 2D CAD file format and the **root of the entire Duc ecosystem**. [`ducpy`](https://pypi.org/project/ducpy/), [`ducjs`](https://www.npmjs.com/package/ducjs), and the rest of the toolchain are all built on top of the types, parsers and storage layer defined here.
+
+A `.duc` file is a standard zlib compressed **SQLite database file** following the schema in `schema/duc.sql`. This crate wraps that database in a strongly-typed Rust API for reading, writing and manipulating `.duc` documents.
+
+
+----
+<br/>
+<br/>
+<br/>
+
+## Schema and migrations
+
+The canonical SQL lives at `schema/duc.sql` (plus `schema/version_control.sql` and `schema/search.sql`) and is **embedded at compile time** by [`build.rs`](build.rs)
+
+Migrations are ran and handled **automatically** upon usage of the library. Each migration is a SQL file named `<from>_to_<to>.sql` in `schema/migrations/`. `build.rs` scans that directory, sorts by `from_version` and emits a static `MIGRATIONS` array. Adding a new migration requires **no Rust changes** — drop the file in and rebuild.
+
+## Features
+
+| Feature | Default | Description |
+|---------|---------|-------------|
+| `default` | ✅ | Native build with bundled SQLite |
+| `opfs` | ❌ | OPFS SAH-pool VFS for `wasm32-unknown-unknown` (browser persistence) |
+
+
+## Documentation
+
+- Full API reference: [docs.rs/duc](https://docs.rs/duc)
+- Format specification, concepts and guides: [duc.ducflair.com](https://duc.ducflair.com)
+
+## Tools
+
+- [Playground](https://ducflair.com/core): Experiment with the `.duc` format in the browser.
+
+## Contributing
+
+Feel free to open an issue or contact us at [Ducflair Support](https://www.ducflair.com/support).
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for more details.

{ducpy-3.3.7 → ducpy-3.4.0}/packages/ducrs/build.rs

@@ -25,6 +25,7 @@ fn decode_user_version_to_semver(user_version: u32) -> String {
 }
 
 fn find_schema_dir(manifest_dir: &Path) -> Result<PathBuf, Box<dyn std::error::Error>> {
+    // 1. Explicit override.
     if let Ok(path) = env::var("DUC_SCHEMA_DIR") {
         let candidate = PathBuf::from(path);
         if candidate.join("duc.sql").is_file() {
@@ -32,22 +33,25 @@ fn find_schema_dir(manifest_dir: &Path) -> Result<PathBuf, Box<dyn std::error::E
         }
     }
 
-    for ancestor in manifest_dir.ancestors() {
-        for candidate in [
-            ancestor.join("schema"),
-            ancestor.join("packages").join("ducpy").join("schema"),
-        ] {
-            if candidate.join("duc.sql").is_file() {
-                return Ok(candidate);
-            }
-        }
+    // 2. Schema inside the crate directory (symlink in dev, real files after
+    //    `cargo publish` dereferences the symlink into the tarball).
+    let bundled = manifest_dir.join("schema");
+    if bundled.join("duc.sql").is_file() {
+        return Ok(bundled);
     }
 
-    Err(format!(
-        "Could not locate schema/duc.sql from {}. Set DUC_SCHEMA_DIR to a directory containing duc.sql.",
-        manifest_dir.display()
-    )
-    .into())
+    // 3. Local workspace: walk up to the repo root `schema/`.
+    let source = manifest_dir
+        .ancestors()
+        .map(|a| a.join("schema"))
+        .find(|p| p.join("duc.sql").is_file())
+        .ok_or_else(|| {
+            format!(
+                "Could not locate schema/duc.sql from {}. Set DUC_SCHEMA_DIR to a directory containing duc.sql.",
+                manifest_dir.display()
+            )
+        })?;
+    Ok(source)
 }
 
 fn main() -> Result<(), Box<dyn std::error::Error>> {
@@ -106,7 +110,7 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
     let mut reg = String::from(
         "// Auto-generated by build.rs — do not edit by hand.\n\
          // Each entry: (from_version, to_version, sql).\n\
-         pub(crate) static MIGRATIONS: &[(i64, i64, &str)] = &[\n",
+         pub static MIGRATIONS: &[(i64, i64, &str)] = &[\n",
     );
     for (from, to, sql) in &migrations {
         reg.push_str(&format!("    ({from}i64, {to}i64, \""));
@@ -149,4 +153,4 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
     println!("cargo:rerun-if-changed=build.rs");
 
     Ok(())
-} 
+}

{ducpy-3.3.7 → ducpy-3.4.0}/packages/ducrs/src/db/bootstrap.rs

@@ -32,10 +32,24 @@ const CURRENT_VERSION: i64 = {
     val
 };
 
+/// Runtime accessor for the compile-time schema version integer.
+pub fn current_schema_version_int() -> i64 {
+    CURRENT_VERSION
+}
+
 // Migration registry auto-generated by build.rs from `schema/migrations/*.sql`.
 // Each entry is (from_version, to_version, sql). Sorted ascending by from_version.
 include!(concat!(env!("OUT_DIR"), "/migrations_registry.rs"));
 
+// ── Public re-exports for downstream crates ─────────────────────────────
+
+/// Current schema version as a semver string (generated at build time).
+pub const CURRENT_SCHEMA_VERSION_SEMVER: &str = env!("DUC_SCHEMA_VERSION");
+
+pub const DUC_SCHEMA_SQL: &str = DUC_SCHEMA;
+pub const VERSION_CONTROL_SCHEMA_SQL: &str = VERSION_CONTROL_SCHEMA;
+pub const SEARCH_SCHEMA_SQL: &str = SEARCH_SCHEMA;
+
 /// Per-connection PRAGMAs that must be re-applied on every open (they are
 /// either ephemeral or take effect only after the first statement on the
 /// connection).

{ducpy-3.3.7 → ducpy-3.4.0}/packages/ducrs/src/db/mod.rs

@@ -3,7 +3,7 @@
 //! Call [`open_file`] or [`open_memory`] instead of calling `rusqlite::Connection`
 //! directly. Internally they dispatch to the correct backend for each compile target.
 
-mod bootstrap;
+pub mod bootstrap;
 
 #[cfg(not(all(target_family = "wasm", target_os = "unknown")))]
 mod native;

{ducpy-3.3.7 → ducpy-3.4.0}/pyproject.toml

@@ -34,8 +34,6 @@ python-packages = ["ducpy", "ducpy_native"]
 module-name = "ducpy_native"
 include = [
     { path = "LICENSE", format = "sdist" },
-    { path = "schema/**/*", format = "sdist" },
-    { path = "schema/**/*", format = "wheel" }
 ]
 manifest-path = "packages/ducpy/crate/Cargo.toml"
 python-source = "src"