[](https://pycmx.readthedocs.io/en/latest/?badge=latest)   [](https://pypi.org/project/pycmx/) 
[](https://github.com/iluvcapra/pycmx/actions/workflows/python-package.yml)
# pycmx
The `pycmx` package provides a basic interface for parsing a CMX 3600 EDL and its most most common variations.
## Features
* The major variations of the CMX 3600: the standard, "File32" and "File128"
formats are automatically detected and properly read.
* 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.
* 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
tolerant of EDLs with mixed rates.
* Unrecognized lines are accessible on the `EditList` and `Event` classes
along with the line numbers, to help the client diagnose problems with a
list and give the client the ability to extend the package with their own
parsing code.
## Usage
### Opening and Parsing EDL Files
```
>>> import pycmx
>>> with open("tests/edls/TEST.edl") as f
... edl = pycmx.parse_cmx3600(f)
...
>>> edl.title
'DC7 R1_v8.2'
```
### Reading Events and Edits
`EditList.events` is a generator...
```
>>> events = list( edl.events )
>>> len(events)
120
>>> events[43].number
'044'
```
...and events contain 1...n edits.
```
>>> events[43].edits[0].source_in
'00:00:00:00'
>>> events[43].edits[0].transition.cut
True
>>> events[43].edits[0].record_out
'01:10:21:10'
```
### Acessing Transitions and Enabled Channels
```
>>> events[41].edits[0].transition.dissolve
False
>>> events[41].edits[1].transition.dissolve
True
>>> events[41].edits[0].clip_name
'TC R1 V1.2 TEMP1 DX M.WAV'
>>> events[41].edits[1].clip_name
'TC R1 V6 TEMP2 M DX.WAV'
# parsed channel maps are also
# available to the client
>>> events[2].edits[0].channels.get_audio_channel(7)
True
>>> events[2].edits[0].channels.get_audio_channel(6)
False
>>> for c in events[2].edits[0].channels.channels:
... print(f"Audio channel {c} is present")
...
Audio channel 7 is present
>>> events[2].edits[0].channels.video
False
```
Raw data
{
"_id": null,
"home_page": "https://github.com/iluvcapra/pycmx",
"name": "pycmx",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "parser, film, broadcast",
"author": "Jamie Hardt",
"author_email": "jamiehardt@me.com",
"download_url": "https://files.pythonhosted.org/packages/b5/8a/f81c4168ba61d270190a961dc1e9084ddbeb2c8e9e36fbef55631c2f9907/pycmx-1.2.3.tar.gz",
"platform": null,
"description": "[](https://pycmx.readthedocs.io/en/latest/?badge=latest)   [](https://pypi.org/project/pycmx/) \n\n[](https://github.com/iluvcapra/pycmx/actions/workflows/python-package.yml)\n\n\n# pycmx\n\nThe `pycmx` package provides a basic interface for parsing a CMX 3600 EDL and its most most common variations.\n\n## Features\n\n* The major variations of the CMX 3600: the standard, \"File32\" and \"File128\" \n formats are automatically detected and properly read.\n* Preserves relationship between events and individual edits/clips.\n* Remark or comment fields with common recognized forms are read and \n available to the client, including clip name and source file data.\n* Symbolically decodes transitions and audio channels.\n* Does not parse or validate timecodes, does not enforce framerates, does not\n parameterize timecode or framerates in any way. This makes the parser more\n tolerant of EDLs with mixed rates.\n* Unrecognized lines are accessible on the `EditList` and `Event` classes\n along with the line numbers, to help the client diagnose problems with a\n list and give the client the ability to extend the package with their own\n parsing code.\n\n## Usage\n\n### Opening and Parsing EDL Files\n```\n>>> import pycmx\n>>> with open(\"tests/edls/TEST.edl\") as f\n... \tedl = pycmx.parse_cmx3600(f)\n...\n>>> edl.title\n'DC7 R1_v8.2'\n```\n\n### Reading Events and Edits\n\n`EditList.events` is a generator...\n\n```\n>>> events = list( edl.events ) \n>>> len(events)\n120\n>>> events[43].number \n'044'\n```\n\n...and events contain 1...n edits.\n\n```\n>>> events[43].edits[0].source_in \n'00:00:00:00'\n>>> events[43].edits[0].transition.cut\nTrue\n>>> events[43].edits[0].record_out\n'01:10:21:10'\n```\n\n### Acessing Transitions and Enabled Channels\n\n``` \n>>> events[41].edits[0].transition.dissolve\nFalse\n>>> events[41].edits[1].transition.dissolve\nTrue\n>>> events[41].edits[0].clip_name\n'TC R1 V1.2 TEMP1 DX M.WAV'\n>>> events[41].edits[1].clip_name\n'TC R1 V6 TEMP2 M DX.WAV'\n \n # parsed channel maps are also\n # available to the client\n>>> events[2].edits[0].channels.get_audio_channel(7)\nTrue\n>>> events[2].edits[0].channels.get_audio_channel(6)\nFalse\n>>> for c in events[2].edits[0].channels.channels:\n... print(f\"Audio channel {c} is present\")\n... \nAudio channel 7 is present\n>>> events[2].edits[0].channels.video\nFalse\n```\n\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python CMX 3600 Edit Decision List Parser",
"version": "1.2.3",
"project_urls": {
"Documentation": "https://pycmx.readthedocs.io/",
"Homepage": "https://github.com/iluvcapra/pycmx",
"Repository": "https://github.com/iluvcapra/pycmx.git",
"Tracker": "https://github.com/iluvcapra/pycmx/issues"
},
"split_keywords": [
"parser",
" film",
" broadcast"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5603fe80d6189d9d059d1edb7b4c34fabab74d5ae64693be372dd52cf7a9121a",
"md5": "d90c2f100c230d32ea524474f8c8f8f3",
"sha256": "7ae5f3ba7be35f164abfbd550b704edd56713b94b57a68a523ad7983d821742b"
},
"downloads": -1,
"filename": "pycmx-1.2.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d90c2f100c230d32ea524474f8c8f8f3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 11600,
"upload_time": "2024-11-26T19:23:26",
"upload_time_iso_8601": "2024-11-26T19:23:26.308249Z",
"url": "https://files.pythonhosted.org/packages/56/03/fe80d6189d9d059d1edb7b4c34fabab74d5ae64693be372dd52cf7a9121a/pycmx-1.2.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b58af81c4168ba61d270190a961dc1e9084ddbeb2c8e9e36fbef55631c2f9907",
"md5": "04669fad744a8889c103516db1ab57b3",
"sha256": "e427690d6cafccb95fd66d7bcaa79eac381e3db014d1a2b12d2bcb6dbf397314"
},
"downloads": -1,
"filename": "pycmx-1.2.3.tar.gz",
"has_sig": false,
"md5_digest": "04669fad744a8889c103516db1ab57b3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 10077,
"upload_time": "2024-11-26T19:23:27",
"upload_time_iso_8601": "2024-11-26T19:23:27.670364Z",
"url": "https://files.pythonhosted.org/packages/b5/8a/f81c4168ba61d270190a961dc1e9084ddbeb2c8e9e36fbef55631c2f9907/pycmx-1.2.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-26 19:23:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "iluvcapra",
"github_project": "pycmx",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pycmx"
}
JSON
