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

docuentation

Browse Source
This commit is contained in:
Jamie Hardt
2025-12-16 17:43:11 -08:00
parent f968b777a8
commit f0a445b2b2
2 changed files with 23 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@@ -17,7 +17,8 @@ The `pycmx` package parses a CMX 3600 EDL and its most most common variations.
* Preserves relationship between events and individual edits/clips.
* Remark or comment fields with common recognized forms are read and
available to the client, including clip name and source file data.
* ASC SOP, Saturation and FRMC statements are parsed and decoded.
* [ASC CDL][asc] and FRMC/VFX framecount statements are parsed and
decoded.
* Symbolically decodes transitions and audio channels.
* Does not parse or validate timecodes, does not enforce framerates, does not
parameterize timecode or framerates in any way. This makes the parser more
@@ -27,6 +28,8 @@ The `pycmx` package parses a CMX 3600 EDL and its most most common variations.
list and give the client the ability to extend the package with their own
parsing code.
[asc]: https://en.wikipedia.org/wiki/ASC_CDL
## Usage
### Opening and Parsing EDL Files

20
docs/source/index.rst
View File

@@ -19,7 +19,7 @@ Features
* Preserves relationship between events and individual edits/clips.
* Remark or comment fields with common recognized forms are read and
available to the client, including clip name and source file data.
* ASC SOP, Saturation and FRMC statements are parsed and decoded.
* `ASC CDL`_ and FRMC statements are parsed and decoded.
* Symbolically decodes transitions and audio channels.
* Does not parse or validate timecodes, does not enforce framerates, does not
parameterize timecode or framerates in any way. This makes the parser more
@@ -29,6 +29,24 @@ Features
list and give the client the ability to extend the package with their own
parsing code.
.. _ASC CDL: https://en.wikipedia.org/wiki/ASC_CDL
Getting Started
----------------
Install `pycmx` with pip.
.. code-block:: sh
pip install pycmx
`pycmx` parses an EDL with the `parse_cmx3600` function:
.. code-block:: python
import pycmx
with open("tests/edls/TEST.edl") as f
... edl = pycmx.parse_cmx3600(f)
.. toctree::
:maxdepth: 5