You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: packages/ducjs/README.md
+3-12Lines changed: 3 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,22 +20,13 @@ For detailed documentation, including all available types and utility functions,
20
20
21
21
## Tools
22
22
23
-
-[Playground](https://ducflair.com/core): Experiment with the `duc` format in a live environment.
23
+
-[Playground](https://scopture.com/w/hollow): Experiment with the `duc` format in a live environment.
24
24
-[Documentation](https://duc.ducflair.com): Comprehensive guides and API references.
25
25
26
26
## Contributing
27
27
28
-
At the moment we are not accepting contributions to this package. However, we welcome feedback and suggestions for future improvements. Feel free to open an issue or contact us at [Ducflair Support](https://www.ducflair.com/support).
28
+
Feel free to open an issue or contact us at [Ducflair Support](https://www.ducflair.com/support).
29
29
30
30
## License
31
31
32
-
This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for more details.
33
-
34
-
35
-
## Commit Message Guidelines
36
-
37
-
To ensure smooth releases with semantic-release, please follow [these guidelines](https://semantic-release.gitbook.io/semantic-release#how-does-it-work).
38
-
39
-
---
40
-
41
-
*The duc format and libraries are constantly evolving, aiming to set new standards in the 2D CAD industry. Be a part of this transformation and help shape the future of design technology!*
32
+
This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for more details.
Copy file name to clipboardExpand all lines: packages/ducpdf/README.md
+3-12Lines changed: 3 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,22 +23,13 @@ For detailed documentation, including all available types and utility functions,
23
23
24
24
## Tools
25
25
26
-
-[Playground](https://ducflair.com/core): Experiment with the `duc` format in a live environment.
26
+
-[Playground](https://scopture.com/w/hollow): Experiment with the `duc` format in a live environment.
27
27
-[Documentation](https://duc.ducflair.com): Comprehensive guides and API references.
28
28
29
29
## Contributing
30
30
31
-
At the moment we are not accepting contributions to this package. However, we welcome feedback and suggestions for future improvements. Feel free to open an issue or contact us at [Ducflair Support](https://www.ducflair.com/support).
31
+
Feel free to open an issue or contact us at [Ducflair Support](https://www.ducflair.com/support).
32
32
33
33
## License
34
34
35
-
This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for more details.
36
-
37
-
38
-
## Commit Message Guidelines
39
-
40
-
To ensure smooth releases with semantic-release, please follow [these guidelines](https://semantic-release.gitbook.io/semantic-release#how-does-it-work).
41
-
42
-
---
43
-
44
-
*The duc format and libraries are constantly evolving, aiming to set new standards in the 2D CAD industry. Be a part of this transformation and help shape the future of design technology!*
35
+
This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for more details.
Copy file name to clipboardExpand all lines: packages/ducpdf/src/duc2pdf/README.md
+2-10Lines changed: 2 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -65,18 +65,10 @@ For detailed documentation, including all available types and utility functions,
65
65
66
66
## Tools
67
67
68
-
-[Playground](https://ducflair.com/core): Experiment with the `duc` format in a live environment.
68
+
-[Playground](https://scopture.com/w/hollow): Experiment with the `duc` format in a live environment.
69
69
-[Documentation](https://duc.ducflair.com): Comprehensive guides and API references.
70
70
71
71
72
72
## License
73
73
74
-
This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for more details.
75
-
76
-
## Commit Message Guidelines
77
-
78
-
To ensure smooth releases with semantic-release, please follow [these guidelines](https://semantic-release.gitbook.io/semantic-release#how-does-it-work).
79
-
80
-
---
81
-
82
-
*The duc format and libraries are constantly evolving, aiming to set new standards in the 2D CAD industry. Be a part of this transformation and help shape the future of design technology!*
74
+
This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for more details.
Copy file name to clipboardExpand all lines: packages/ducpy/README.md
+49-27Lines changed: 49 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,54 +12,76 @@
12
12
</p>
13
13
</p>
14
14
15
-
16
-
The `ducpy` package provides a robust Python implementation for the `duc` 2D CAD file format, a cornerstone of our advanced design system. Designed for professionals seeking precision and efficiency, this package ensures seamless integration and manipulation of `duc` files within your Python projects.
17
-
18
-
## Introduction
19
-
20
-
The `ducpy` package offers comprehensive Python types and helper functions to work effortlessly with the `duc` CAD file format. Built with efficiency and performance in mind, this package enables you to parse, validate, and manipulate `duc` files with ease.
21
-
22
-
## Features
23
-
24
-
-**Python Support:** Strongly-typed interfaces for all aspects of the `duc` file format, ensuring type safety and IDE support.
25
-
-**Utility Functions:** Easy-to-use functions for parsing, validating, and manipulating `duc` files.
26
-
-**Extensible Architecture:** Designed to integrate seamlessly with other `ducflair` packages and your custom tools.
27
-
-**Performance Optimized:** Efficient processing to handle complex CAD data with ease.
15
+
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.
28
16
29
17
## Installation
30
18
31
-
Install the package using pip:
32
-
33
19
```bash
34
20
pip install ducpy
35
21
```
36
22
37
-
## Usage
23
+
or with [`uv`](https://docs.astral.sh/uv/):
24
+
25
+
```bash
26
+
uv add ducpy
27
+
```
28
+
29
+
## Quick start
38
30
39
31
```python
40
32
import ducpy as duc
41
33
```
42
34
35
+
## API overview
36
+
37
+
`ducpy` is organised around four conceptual entry points, matching the structure of the full [API reference](https://duc.ducflair.com):
38
+
39
+
### Builders API (High-level)
40
+
41
+
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.
42
+
43
+
See the worked examples:
44
+
45
+
-[Element creation](src/examples/element_creation_demo.py) — building rectangles, ellipses, polygons, lines, arrows, text, frames and plots with the fluent builder DSL.
46
+
-[Mutating elements](src/examples/mutation_demo.py) — updating element properties in place and observing version changes.
47
+
-[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.
48
+
49
+
### SQL Builder (Low-level)
50
+
51
+
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.
52
+
53
+
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.
54
+
55
+
### Search
56
+
57
+
Query and search elements and files programmatically through the `duc.search` API.
58
+
59
+
### File I/O
60
+
61
+
Read and write `.duc` files using the `duc.parse` and `duc.serialize` modules.
-[Serialization](src/examples/serialization_demo.py) — `serialize_duc` from builder-created elements.
67
+
-[External files](src/examples/external_files_demo.py) — attaching binary blobs (images, PDFs) to a `.duc` document.
68
+
43
69
## Documentation
44
70
45
-
For detailed documentation, including all available types and utility functions, visit our [Documentation](https://duc.ducflair.com).
71
+
For detailed documentation, including the full API reference, schema specification, and end-to-end examples, see:
72
+
73
+
- API reference & guides: [duc.ducflair.com](https://duc.ducflair.com)
74
+
- Source-level reference: [docs/](docs/index.rst)
75
+
- Full example index: [docs/examples.rst](docs/examples.rst)
46
76
47
77
## Tools
48
78
49
79
-[Playground](https://scopture.com): Experiment with the `duc` format in a live environment.
50
80
51
81
## Contributing
52
82
53
-
At the moment we are not accepting contributions to this package. However, we welcome feedback and suggestions for future improvements. Feel free to open an issue or contact us at [Ducflair Support](https://www.ducflair.com/support).
83
+
Feel free to open an issue or contact us at [Ducflair Support](https://www.ducflair.com/support).
54
84
55
85
## License
56
86
57
-
This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for more details.
58
-
59
-
## Commit Message Guidelines
60
-
61
-
To ensure smooth releases with semantic-release, please follow [these guidelines](https://semantic-release.gitbook.io/semantic-release#how-does-it-work).
62
-
63
-
---
64
-
65
-
*The duc format and libraries are constantly evolving, aiming to set new standards in the 2D CAD industry. Be a part of this transformation and help shape the future of design technology!*
87
+
This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for more details.
0 commit comments