Skip to content

README.md

Latest commit

 

History

History
89 lines (64 loc) · 5.34 KB

README.md

File metadata and controls

89 lines (64 loc) · 5.34 KB
Raw

Clips Kitty SDK (clipskitty_sdk)

A small Python package for writing Clips Kitty plugins: read the job, report progress, find moments or rate and describe the moments found, and check a plugin's manifest. It uses the Python standard library only (reading a YAML manifest also needs PyYAML).

Licence: MIT (LICENSE). Clips Kitty itself is AGPL-3.0-or-later; the SDK is MIT so that a plugin, app or tool built on it can use any licence its author chooses, open or closed. Using the SDK does not put your code under the AGPL.

Install

PowerShell (Windows):

py -m pip install "clipskitty-sdk[yaml] @ git+https://github.com/ColinGPT9/clips-studio#subdirectory=sdk/python"

bash (macOS, Linux):

python -m pip install "clipskitty-sdk[yaml] @ git+https://github.com/ColinGPT9/clips-studio#subdirectory=sdk/python"

Clips Kitty 2.1.0 is the first release that runs plugins, and it comes with SDK 1.3.0.

How to run it from source: From source. Which release runs plugins: Versioning.

The yaml extra adds PyYAML, for reading manifests. Write [yaml,test] in place of [yaml] to add pytest too, for your plugin's own tests.

Inside the app you never install it. Clips Kitty bundles the SDK from the commit it is built from and puts that copy on your plugin's path, where it wins over one installed with pip.

Try it

PowerShell (Windows):

py -m clipskitty_sdk --version
py -m clipskitty_sdk validate path\to\your-plugin
py -m clipskitty_sdk run path\to\your-plugin --video video.mp4

bash (macOS, Linux):

python -m clipskitty_sdk --version
python -m clipskitty_sdk validate path/to/your-plugin
python -m clipskitty_sdk run path/to/your-plugin --video video.mp4

--version prints the SDK's version and the plugin contract it follows, such as clipskitty-sdk 1.2.0 (plugin contract 1). pip also installs a clipskitty-sdk command that does the same as python -m clipskitty_sdk; these pages use the -m form, because pip's command folder is often not on PATH on Windows.

How a plugin fits in

Clips Kitty SDK

Input                      a link or a video file
  ↓
Video                      Clips Kitty downloads it and writes down what is said
  ↓
Your plugin                every step is optional
  ├── find                 picks the moments                  built
  ├── understand           says what happens in each one      built
  ├── rate                 scores each moment                 built
  └── edit                 suggests edits for the creator     built
  ↓
Clips Kitty                does every step no plugin does, then cuts, frames and captions the clips
  ↓
Creator / Social Platform  posts when the creator clicks Publish, or on a schedule or automatic posting the creator switched on
  • One plugin can find moments for a video; it replaces Clips Kitty's own finding.
  • Up to 3 plugins can understand and up to 3 can rate, after any finder.
  • A plugin's role comes from inputs and outputs in its manifest (Steps).
  • Up to 3 plugins can suggest edits for the clips that will be made: job.wants("edit") answers True in that run.
  • Edit plugins suggest edits that wait for the creator in the editor (Steps).
  • Posting isn't a plugin step: Clips Kitty posts clips itself, and through WoopSocial it can post to many sites at once on the creator's own account (Publish to every platform at once). job.wants("export") answers False, and kind: publisher is refused: plugins don't post. Affiliate link - Clips Kitty may earn a commission if you sign up through it, at no extra cost to you.

Get listed

When your plugin works, list it in Awesome Clips Kitty, the catalog Clips Kitty's Marketplace reads: Getting listed.

Documentation