README.md

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 using pip:

pip install pybinlock

Or clone from this repo:

git clone https://github.com/mjiggidy/pybinlock.git
cd pybinlock
pip install .

Now you can import binlock!

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 for general usage and API documentation!

See Also

• pybinhistory - Programmatically read and write Avid bin history log (.log) files