Skip to content

Commit

Permalink
deploy: a3c637e
Browse files Browse the repository at this point in the history
  • Loading branch information
tweak-wtf committed Jul 13, 2024
0 parents commit 8b50d7b
Show file tree
Hide file tree
Showing 37 changed files with 6,516 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: ec548138aa69a1658e8512b329f537fa
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file added .doctrees/README.doctree
Binary file not shown.
Binary file added .doctrees/environment.pickle
Binary file not shown.
Binary file added .doctrees/index.doctree
Binary file not shown.
Binary file added .doctrees/modules.doctree
Binary file not shown.
Empty file added .nojekyll
Empty file.
401 changes: 401 additions & 0 deletions README.html

Large diffs are not rendered by default.

70 changes: 70 additions & 0 deletions _sources/README.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
LabLib
======

.. image:: https://img.shields.io/badge/os-windows-blue

Generate intermediate sequences for VFX processing using OIIO and
FFMPEG!

This module aims to help by providing helper classes and functions to: -
Get basic info from videos and images using iinfo and ffprobe as a
fallback. - Read and parse effect json outputted by
`AYON/Openpype <https://github.com/ynput>`__ for pipeline automation. -
Create a custom OCIO config file for direct use. - Create OIIO and
FFMPEG matrix values to be used in filters for repositioning. - Create
correctly formed OIIO commandline strings automatically. - Render out
frames with Color and Repositioning baked in using oiiotool

Instructions
------------

The core functionality relies on using **Processors** and **Operators**
to compute the correct commandline parameters.

**Operators** are single operation classes that hold your operation
parameters (translation, luts, cdls etc.)

**Processors** (usually classes such as ``ColorTransformProcessor``)
compute **Operators** chains together. They can be fed ordered lists of
dicts (with same name attributes as Operator classes) or ordered lists
of **Operators** objects, or one at a time for secondary processing
between the chained operations. On compute they return their relevant
section of commandline flags to be passed to oiio.

**Renderers** take care of returning the fully formed commanline command
and executing it.

Installation
------------

LabLib requires ``python-3.9`` and uses ``poetry`` for managing its
dependencies.

It’s encouraged to use the provided PowerShell script to install and
download the binaries for
`oiiotool <https://www.patreon.com/posts/openimageio-oiio-63609827>`__,
`ffmpeg <https://github.com/GyanD/codexffmpeg/releases/tag/7.0.1>`__,
the `OCIO Color
Configs <https://github.com/colour-science/OpenColorIO-Configs/releases/tag/v1.2>`__
and the font `Source Code
Pro <https://fontsource.org/fonts/source-code-pro>`__ which is used in
tests.

- clone this repo
- ``.\start.ps1 install``
- ``.\start.ps1 get-dependencies``

Testing
~~~~~~~

You can run the full suite with ``.\start.ps1 test`` or to run custom
``pytest`` commands make sure to be in the cloned repository’s directory
and run ``poetry run pytest [ARGS]``.

Contributing
------------

The best way to contribute to LabLib currently is to write extensive
test cases for all modules. But also sharing your thoughts and ideas on
the `Discussions Page <https://github.com/ynput/LabLib/discussions>`__
really helps to keep this project going 💞
15 changes: 15 additions & 0 deletions _sources/index.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
Welcome to LabLib's documentation!
==================================
.. toctree::
:maxdepth: 3

README <README>
modules


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
33 changes: 33 additions & 0 deletions _sources/modules.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
lib
========

.. automodule:: lablib.lib
:members:


operators
=========

.. automodule:: lablib.operators
:members:


generators
==========

.. automodule:: lablib.generators
:members:


processors
==========

.. automodule:: lablib.processors
:members:


renderers
=========

.. automodule:: lablib.renderers
:members:
Loading

0 comments on commit 8b50d7b

Please sign in to comment.