vfx-seqtools 0.2.0

CLI utilities for working with VFX frame sequences.

VFX seqtools

Command-line utilities for working with frame sequences in Animation and VFX.

This is the readme for developers. The documentation for users is available here: https://jdmacleod.github.io/vfx-seqtools/

Prerequisites

You will need Python installed. All Supported versions of Python have been tested to work.

Quickstart

Install using pip or pipx.

$ pip install vfx-seqtools

or

$ pipx install vfx-seqtools

This will provide the command-line utilities:

• seqchk - check frame sequences in the current directory for file consistency. Uses pillow.
• seqcp - copy frames according to provided name patterns and frame range.
• seqdo - do command(s), substituting in the provided frame range.
• seqexp - expand a frame sequence, to evaluate it visually.
• seqgen - given a list of framenumbers, make a frame sequence.
• seqls - list frame sequences in the current directory.
• seqmv - move (rename) frames according to provided name patterns and frame range.
• seqrm - remove (delete) frames according to provided name patterns and frame range.

See the user documentation for examples.

Developer Setup

Clone this repository (or fork on GitHub).

In the local repository directory, set up for Python development. The steps below show Astral's uv in use - but using Python venv is also fine.

# Create and activate Python virtual environment
uv venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate

# Install development dependencies with the project set as editable
uv pip install -e ".[dev]"

# Install Git pre-commit hooks
pre-commit install

Create a feature branch and make changes. See TESTS.md for details on running this product's tests.

Contributing

Contributions to improve these utilities are welcome! Please submit issues and pull requests on GitHub.

License

This code is MIT licensed. See the LICENSE file for details.

Reference

• Ryan Galloway's PySeq library
• Geoff Harvey's seqparse library
• Cyril Pichard's filesequence library
• Matt Chambers and Justin Israel's fileseq library
• Matthias Baas' Python Computer Graphics Kit