My Virtual Rig (MVR) library for Python
Project description
python-mvr
Python library for MVR (My Virtual Rig). MVR is part of GDTF (General Device Type Format)
MVR specification as per https://gdtf.eu/mvr/prologue/introduction/
See source code for documentation. Naming conventions, in general, are identical to that on the GDTF, CamelCase is replaced with underscore_delimiters.
Installation
pip install pymvr
To install latest version from git via pip:
python -m pip install https://codeload.github.com/open-stage/python-mvr/zip/refs/heads/master
Usage
Reading
import pymvr
mvr_scene = pymvr.GeneralSceneDescription("mvr_file.mvr")
for layer_index, layer in enumerate(mvr_scene.layers):
... #process data
Writing
fixtures_list = []
mvr = pymvr.GeneralSceneDescriptionWriter()
pymvr.UserData().to_xml(parent=mvr.xml_root)
scene = pymvr.SceneElement().to_xml(parent=mvr.xml_root)
layers = pymvr.LayersElement().to_xml(parent=scene)
layer = pymvr.Layer(name="Test layer").to_xml(parent=layers)
child_list = pymvr.ChildList().to_xml(parent=layer)
fixture = pymvr.Fixture(name="Test Fixture") # not really a valid fixture
child_list.append(fixture.to_xml())
fixtures_list.append((fixture.gdtf_spec, fixture.gdtf_spec))
pymvr.AUXData().to_xml(parent=scene)
mvr.files_list = list(set(fixtures_list))
mvr.write_mvr("example.mvr")
See BlenderDMX and tests for reference implementation.
Status
-
Reading:
- Address
- Alignment
- AUXData
- ChildList
- Class
- Connection
- CustomCommand
- Data
- Fixture
- FocusPoint
- Geometries
- Geometry3D
- Gobo
- GroupObject
- Layer
- Mapping
- Overwrite
- Position
- Projector
- Protocol
- SceneObject
- Sources
- Support
- Symbol
- Symdef
- Truss
- UserData
- VideoScreen
-
Writing:
- Fixture
- Focus point
- creating MVR zip file
Development
Typing
- At this point, the
--no-strict-optional
is needed for mypy tests to pass:
mypy pymvr/*py --pretty --no-strict-optional
Format
- to format, use
ruff
Testing
- to test, use
pytest
- to test typing with mypy use:
pytest --mypy -m mypy pymvr/*py
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
pymvr-0.3.0.dev0-py3-none-any.whl
(10.2 kB
view hashes)
Close
Hashes for pymvr-0.3.0.dev0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f0b62c5e3e38b958ef1d8f8db366721d9ac4cd8f44a176552911fd5740981736 |
|
MD5 | 4801e79a37c5d9ea57a9770798b864f0 |
|
BLAKE2b-256 | 1fafe8743da9a1f3a9e8a9bce945babaaf61133256c646fb2452e528279832b5 |