Skip to content

Commit b61d199

Browse files
committed
Release v1.4.0
1 parent fcc5b6e commit b61d199

File tree

2 files changed

+11
-12
lines changed

2 files changed

+11
-12
lines changed

README.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -110,10 +110,11 @@ from pathlib import Path
110110
# parse a GDTF file
111111
fixture = pygdtf.FixtureType("BlenderDMX@LED_PAR_64_RGBW@v0.3.gdtf")
112112

113-
# create writer that reuses the parsed XML tree and embedded resources
113+
# modify the fixture as needed, you must ensure GDTF correctness
114+
# create writer
114115
writer = pygdtf.FixtureTypeWriter(fixture)
115116

116-
# write a new GDTF archive (DataVersion can be overridden if desired)
117+
# write a new GDTF archive
117118
writer.write_gdtf(Path("BlenderDMX@LED_PAR_64_RGBW@v0.3_roundtrip.gdtf"))
118119
```
119120

@@ -162,20 +163,18 @@ uv run pytest --mypy -m mypy pygdtf/*py
162163

163164
## Updating Attribute Definitions
164165

165-
The canonical AttributeDefinitions XML lives at the repo root:
166-
`AttributeDefinitions.xml`. When the GDTF spec updates that file, regenerate
167-
the baked Python data module used for zero-IO startup:
166+
The canonical AttributeDefinitions XML is from the [GDTF
167+
Spec](https://github.com/mvrdevelopment/spec), and it is stored at the repo
168+
root: `AttributeDefinitions.xml`. When the GDTF Spec updates that file, we need
169+
to regenerate the baked Python data module by running the following:
168170

169171
```bash
170-
python3 - <<'PY'
171-
from pygdtf.utils import attr_loader
172-
attr_loader.generate_attribute_definitions_module()
173-
PY
172+
uv run python -c "from pygdtf.utils import attr_loader; attr_loader.generate_attribute_definitions_module()"
174173
```
175174

176175
This writes `pygdtf/utils/attribute_definitions_data.py`, which is imported at
177-
runtime instead of reading the XML. Commit the regenerated module along with
178-
the updated XML.
176+
runtime instead of reading the XML. Format and commit the regenerated module
177+
along with the updated XML.
179178

180179
## Citation
181180

pygdtf/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
from .utils import *
4242
from .value import * # type: ignore
4343

44-
__version__ = "1.4.0-dev1"
44+
__version__ = "1.4.0-dev2"
4545

4646
# Standard predefined colour spaces: R, G, B, W-P
4747
COLOR_SPACE_SRGB = ColorSpaceDefinition(

0 commit comments

Comments
 (0)