ducpy
SQLite-backed project-state format for physical-engineering work before execution
The ducpy package is the official Python implementation of the .duc project-state format. It is built on top of the duc Rust crate, exposed as the ducpy_native extension. A .duc file is a gzip-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
pip install ducpy
or with uv:
uv add ducpy
Quick start
import ducpy as duc
API overview
ducpy is organised around four conceptual entry points, matching the structure of the full API reference:
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 — building rectangles, ellipses, polygons, lines, arrows, text, frames and plots with the fluent builder DSL.
- Mutating elements — updating element properties in place and observing version changes.
- Document elements and model elements — for the higher-level container / model element types.
SQL Builder (Low-level)
A .duc file is a gzip-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 — 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 —
parse_duc/list_external_files/ streaming revision helpers. - Serialization —
serialize_ducfrom builder-created elements. - External files — attaching binary blobs (images, PDFs) to a
.ducdocument.
Documentation
For detailed documentation, including the full API reference, schema specification, and end-to-end examples, see:
- API reference & guides: duc.ducflair.com
- Source-level reference: docs/
- Full example index: docs/examples.rst
Tools
- Playground: Experiment with the
ducformat in a live environment.
Contributing
Feel free to open an issue or contact us at Ducflair Support.
License
This project is licensed under the MIT License. See the LICENSE file for more details.
1 maintainer
Metadata
1 maintainer
Release files for ducpy 4.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ducpy-4.1.0.tar.gz | 411.9 kB | Details |
Release files / ducpy-4.1.0.tar.gz
| Download URL | ducpy-4.1.0.tar.gz |
|---|---|
| Size | 411.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
349e25ec16b5de8dd02bdd7c9c746f88a3fb0d48b92a1749233919101f856a60
|
|
BLAKE2b-256 checksum How to use checksums |
c00f289f819ea9ae7dd879acd9e0d7f3d2af2ed8b41b4a072dee1af682f87cb0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.19 {"installer":{"name":"uv","version":"0.12.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
