Metadata-Version: 2.4
Name: lvsfunc
Version: 0.10.4
Summary: A collection of LightArrowsEXE's VapourSynth experimental functions and wrappers
Project-URL: Tracker, https://github.com/Jaded-Encoding-Thaumaturgy/lvsfunc/issues
Project-URL: Contact, https://discord.gg/XTpc6Fa9eB
Project-URL: Changelog, https://github.com/Jaded-Encoding-Thaumaturgy/lvsfunc/blob/master/CHANGELOG.md
Author-email: LightArrowsEXE <LightArrowsReboot@gmail.com>
Maintainer-email: LightArrowsEXE <LightArrowsReboot@gmail.com>
License-Expression: MIT
License-File: LICENSE
Keywords: encoding,filtering,vapoursynth,video,vsjetpack
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: GPU
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Other Audience
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Multimedia :: Video
Classifier: Topic :: Multimedia :: Video :: Display
Classifier: Typing :: Typed
Requires-Python: >=3.12
Requires-Dist: kagefunc>=1.0.1
Requires-Dist: matplotlib>=3.11.0
Requires-Dist: vapoursynth>=74
Requires-Dist: vsfpng>=1.2
Requires-Dist: vsjetpack[denoise,scale]>=2.0.0
Provides-Extra: amd
Requires-Dist: vsjetpack[amd]>=2.0.0; extra == 'amd'
Provides-Extra: basic
Provides-Extra: cl
Requires-Dist: vsjetpack[cl]>=2.0.0; extra == 'cl'
Provides-Extra: nvidia
Requires-Dist: vsjetpack[nvidia]>=2.0.0; extra == 'nvidia'
Description-Content-Type: text/markdown

# lvsfunc

<p align="center">
    <a href="https://pypi.org/project/lvsfunc/"><img alt="PyPI" src="https://img.shields.io/pypi/v/lvsfunc"></a>
    <img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/lvsfunc">
    <a href="https://github.com/Jaded-Encoding-Thaumaturgy/lvsfunc/blob/master/LICENSE"><img alt="PyPI - License" src="https://img.shields.io/pypi/l/lvsfunc"></a>
    <a href="https://coveralls.io/github/Jaded-Encoding-Thaumaturgy/lvsfunc?branch=master"><img alt="Coverage" src="https://img.shields.io/coverallsCoverage/github/Jaded-Encoding-Thaumaturgy/lvsfunc?branch=master"></a>
</p>

<p align="center">
    <a href="https://github.com/Jaded-Encoding-Thaumaturgy/lvsfunc/commits/master"><img alt="GitHub commits since tagged version" src="https://img.shields.io/github/commits-since/Jaded-Encoding-Thaumaturgy/lvsfunc/latest"></a>
    <a href="https://discord.gg/XTpc6Fa9eB"><img alt="Discord" src="https://img.shields.io/discord/856381934052704266?label=discord"></a>
    <a href="https://pypi.org/project/lvsfunc/"><img alt="downloads" src="https://static.pepy.tech/personalized-badge/lvsfunc?period=total&units=international_system&left_color=grey&right_color=blue&left_text=downloads"></a>
</p>

<p align="center">
    <a href="https://ko-fi.com/L4L01ZAPAB">
        <img src="https://ko-fi.com/img/githubbutton_sm.svg" alt="ko-fi">
    </a>
</p>

> [!CAUTION]
>Anything **MAY** change at any time.
>The public API **SHOULD NOT** be considered stable.
>
>Many functions in this package are considered **EXPERIMENTAL** and **UNOPTIMAL** for regular filterchains,
>are likely to require extensive testing,
>or may be moved to a different [_Jaded Encoding Thaumaturgy_](https://github.com/Jaded-Encoding-Thaumaturgy) package at any point.
>
>If you use `lvsfunc` in any of your projects,
>please consider hardcoding a version requirement!

If you're testing new functionality
that may be ported over
to a JET package
in the future,
please make sure to install
the latest version on git.

----

A collection of VapourSynth functions and wrappers
written and/or modified by LightArrowsEXE.
Full information on how every function/wrapper works,
as well as a list of dependencies and links,
can be found in the docstrings of each function/wrapper.
For further support,
drop by `#dev` in the [JET Discord server](https://discord.gg/XTpc6Fa9eB).

## How to install

`lvsfunc` is distributed via PyPi. You can install it with the following command:

```shell
pip install lvsfunc
```

You can install the git latest version with the following command:

```shell
pip install git+https://github.com/Jaded-Encoding-Thaumaturgy/lvsfunc.git
```

## Usage

After installation, functions can be loaded and used as follows:

```py
import lvsfunc as lvf

aa = lvf.deblock.autodb_dpir(...)
comp = lvf.comparison.compare(...)
...
```
