=====================
vstools Documentation
=====================

.. _home:


.. image:: https://img.shields.io/pypi/pyversions/vstools

.. image:: https://img.shields.io/pypi/v/vstools
    :target: https://pypi.org/project/vstools/

.. image:: https://img.shields.io/github/commits-since/Jaded-Encoding-Thaumaturgy/vs-tools/latest
    :target: https://github.com/Jaded-Encoding-Thaumaturgy/vs-tools/commits/master

.. image:: https://img.shields.io/pypi/l/vstools
    :target: https://github.com/Jaded-Encoding-Thaumaturgy/vs-tools/blob/master/LICENSE

.. image:: https://img.shields.io/discord/856381934052704266?label=discord
    :target: https://discord.gg/XTpc6Fa9eB

.. image:: https://static.pepy.tech/personalized-badge/vstools?period=total&units=international_system&left_color=grey&right_color=blue&left_text=downloads
    :target: https://pepy.tech/project/vstools


Functions and utils related to VapourSynth.

This module is a collection of functions, utils, types, type-utils,
and more aimed at helping at having a common ground between VapourSynth packages,
as well as simplify writing and maintaining them.

Want to contribute to vstools?
Check out the `how to contribute <contribute>` section!

.. automodule:: vstools
    :members:
    :undoc-members:
    :show-inheritance:

.. toctree::
    :maxdepth: 1
    :caption: Getting started

    getting_started/install
    getting_started/community

.. toctree::
    :maxdepth: 1
    :caption: Changelogs

    changelogs/changelogs

.. raw:: html

    <hr>
    <div class="toctree-wrapper">
        <p class="caption" style="display: flex;justify-content: center;">User API</p>
    </div>

.. toctree::
    :maxdepth: 1
    :caption: Utils
    :titlesonly:

    submodules/utils/clips
    submodules/utils/info
    submodules/utils/misc
    submodules/utils/ranges
    submodules/utils/scale
    submodules/utils/vapoursynth

.. toctree::
    :maxdepth: 1
    :caption: Functions
    :titlesonly:

    submodules/functions/clip
    submodules/functions/funcs
    submodules/functions/utils

.. toctree::
    :maxdepth: 1
    :caption: Enums
    :titlesonly:

    submodules/enums/color
    submodules/enums/funcs
    submodules/enums/generic

.. raw:: html

    <hr>
    <div class="toctree-wrapper">
        <p class="caption" style="display: flex;justify-content: center;">Developer API</p>
    </div>

.. toctree::
    :maxdepth: 1
    :caption: Dev/Utils
    :titlesonly:

    submodules/utils/ffprobe
    submodules/utils/file
    submodules/utils/funcs
    submodules/utils/math
    submodules/utils/mime
    submodules/utils/other
    submodules/utils/props

.. toctree::
    :maxdepth: 1
    :caption: Dev/Functions
    :titlesonly:

    submodules/functions/check
    submodules/functions/heuristics
    submodules/functions/normalize
    submodules/functions/progress

.. toctree::
    :maxdepth: 1
    :caption: Dev/Enums
    :titlesonly:

    submodules/enums/base
    submodules/enums/other

.. toctree::
    :maxdepth: 1
    :caption: Dev/Exceptions
    :titlesonly:

    submodules/exceptions/base
    submodules/exceptions/color
    submodules/exceptions/enum
    submodules/exceptions/file
    submodules/exceptions/generic

.. toctree::
    :maxdepth: 1
    :caption: Dev/Types
    :titlesonly:

    submodules/types/builtins
    submodules/types/file
    submodules/types/funcs
    submodules/types/generic
    submodules/types/utils

Special Credits
---------------
| A special thanks to every contributor who has contributed to vstools.
| `A comprehensive list of contributors can be found here. <https://github.com/Jaded-Encoding-Thaumaturgy/vs-tools/graphs/contributors>`_


