https://github.com/mjiggidy/pybinlock
Read, write, and manage Avid bin locks programmatically
https://github.com/mjiggidy/pybinlock
automation avb avid composer edit editing editorial lck lock lockfile media nle pipeline post production
Last synced: about 1 month ago
JSON representation
Read, write, and manage Avid bin locks programmatically
- Host: GitHub
- URL: https://github.com/mjiggidy/pybinlock
- Owner: mjiggidy
- License: gpl-3.0
- Created: 2025-02-20T01:42:47.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2025-03-15T18:37:02.000Z (7 months ago)
- Last Synced: 2025-08-28T08:29:11.951Z (about 2 months ago)
- Topics: automation, avb, avid, composer, edit, editing, editorial, lck, lock, lockfile, media, nle, pipeline, post, production
- Language: Python
- Homepage: https://pypi.org/project/pybinlock/
- Size: 91.8 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pybinlock
`binlock` is a python package for programmatically reading and writing Avid bin lock (`.lck`) files in
multi-user Avid Media Composer projects.
>[!WARNING]
>While the `.lck` lock file format is a very simple one, it is officially undocumented. Use this library at your own risk --
>I assume no responsibility for any damage to your project, loss of data, or underwhelming box office performance.
## Interesting Uses
- Permanently locking bins
- Temporarily locking bins while programmatically reading/writing to them
- Custom lock names for displaying short messages, such as why the bin is locked
- Removing "stale" locks
## Installation
Install the `pybinlock` package [from PyPI](https://pypi.org/project/pybinlock/) using `pip`:
```bash
pip install pybinlock
```
Or clone from this repo:
```bash
git clone https://github.com/mjiggidy/pybinlock.git
cd pybinlock
pip install .
```
Now you can import `binlock`!
```python
from binlock import BinLock
with BinLock("Do Not Touch").hold_bin("Reel 1.avb") as my_lock:
print(f"Bin is now locked as {my_lock.name}")
...
print("Bin is now unlocked!")
```
## Usage
See [readthedocs.io](https://pybinlock.readthedocs.io) for general usage and API documentation!
## See Also
- [`pybinhistory`](https://github.com/mjiggidy/pybinhistory) - Programmatically read and write Avid bin history log (`.log`) files