jamie/pycmx
1
0
Fork 0
mirror of https://github.com/iluvcapra/pycmx.git synced 2025-12-31 17:00:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

documentation

Browse Source
This commit is contained in:
Jamie Hardt
2025-12-16 18:01:22 -08:00
parent 5dc6da8f99
commit 58f28e3e2e
2 changed files with 8 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/source/index.rst
View File

@@ -34,13 +34,14 @@ Features
Getting Started Getting Started
---------------- ----------------
Install `pycmx` with pip. Install `pycmx` with pip, or add it with `uv` or your favorite tool.
.. code-block:: sh .. code-block:: sh
pip install pycmx pip install pycmx
`pycmx` parses an EDL with the :func:`pycmx.parse_cmx_events.parse_cmx3600` function: `pycmx` parses an EDL with the :func:`~pycmx.parse_cmx_events.parse_cmx3600`
function:
.. code-block:: python .. code-block:: python
@@ -49,6 +50,10 @@ Install `pycmx` with pip.
with open("tests/edls/TEST.edl") as f: with open("tests/edls/TEST.edl") as f:
edl = pycmx.parse_cmx3600(f) edl = pycmx.parse_cmx3600(f)
This returns a generator tha will yield each :class:`~pycmx.event.Event`.
Events can have multiple edits, if they are a part of a cross-dissolve oe a
key.
.. toctree:: .. toctree::
:maxdepth: 5 :maxdepth: 5

2
pycmx/edit.py
View File

@@ -52,7 +52,7 @@ class Edit:
@property @property
def transition(self) -> Transition: def transition(self) -> Transition:
""" """
Get the :obj:`Transition` object associated with this edit. Get the :obj:`Transition` that initiates this edit.
""" """
if self._trans_name_statement: if self._trans_name_statement:
return Transition(self._edit_statement.trans, return Transition(self._edit_statement.trans,