pyavc 1.0.0

A command line utility and library for converting DOCX and TXT files to Avid Script Files (.avc)

pyavc

pyavc is a Python library that allows you to convert DOCX or TXT files into Avid Script (.avc) files. It can be used both as a command-line tool and as a library within your Python scripts.

This project is not affiliated with Avid or Avid Media Composer, it is simply an open source helper library to make fellow AEs' lives a bit easier.

Installation

To install pyavc, you can use pip3:

pip3 install pyavc

Usage

As a Python Library

The main function exposed to end users is convert. This function allows you to convert a DOCX or TXT file and save the result in a specified output directory.

Function Signature

convert(filepath: os.Path, output_dir: os.Path, output_name=None)

Parameters

• filepath (os.Path): The path to the input DOCX or TXT file.
• output_dir (os.Path): The path to the output directory where the converted file will be saved.
• output_name (str, optional): The name of the output file (without extension). If not provided, the output file will be named based on the input file name.

Example Usage

import pyavc as avc

# Convert a TXT file and save the output
avc.convert('/path/to/input.txt', '/path/to/output/dir')

# Convert a DOCX file and specify a custom output name
avc.convert('/path/to/input.docx', '/path/to/output/dir', output_name='custom_name')

Command-Line Usage

pyavc can also be used from the command line to quickly convert files.

Syntax

pyavc -i <path-to-input-file> -o <path-to-output-dir> [-n <output-name>]

Parameters

• -i, --input: Path to the input DOCX or TXT file.
• -o, --output_dir: Path to the output directory where the converted file will be saved.
• -n, --output_name: (Optional) Name of the output file (without extension). If not provided, the output file will be named based on the input file name.

Example Commands

# Convert a TXT file and save the output
pyavc -i /path/to/input.txt -o /path/to/output/dir

# Convert a DOCX file and specify a custom output name
pyavc -i /path/to/input.docx -o /path/to/output/dir -n custom_name

License

This project is licensed under the GNU 3.0 License. See the LICENSE file for more details.

Contributing

Contributions are welcome! Please open an issue or submit a pull request with any improvements or suggestions.

Acknowledgments

pyavc would not be possible without the pyavb library by mjiggidy, itself a fork of the pyavb library by markreidvfx, which provided so many useful hints - as it turns out, AVC files are constructed much like AVB files. Who would have thought?