/kitsunekko-tools

🍥 A set of scripts for creating a local kitsunekko mirror.

Primary LanguageHTMLGNU Affero General Public License v3.0AGPL-3.0

kitsunekko-tools

A set of scripts for creating a local kitsunekko mirror.

The main benefit of having all subtitles saved locally is that you can browse them using lf and quickly search with fzf.

Install

Install using pipx from pypi.

pipx install kitsunekko-tools

Configure

Run this command to create the config file.

ktools config create

Edit the config file.

  • destination - the local folder where the files should be downloaded.
  • proxy - Your proxy settings. Set to "" (empty string) if you don't use proxies. By default, it is set to the default Tor address.

Everything else usually doesn't need to be changed.

Usage

Tip

Clone kitsunekko-mirror before downloading from kitsunekko directly.

The first time, run full sync. It will download everything.

ktools sync --full

Run sync. If you already have downloaded everything once, this command will skip files that have not been modified recently.

ktools sync

The skip_older config parameter controls what files should be skipped during regular runs.

Upload your mirror to Mega

  1. Install megatools.
  2. Create ~/.megarc and specify your credentials.
  3. Run ktools upload.

Ignoring certain files

To prevent some files from being downloaded (because they are too big, broken, etc.), Create a file named .kitsuignore in the root of destination and fill it with paths relative to destination.

Help

Run ktools --help to print a help page.

Environment variables

  • KITSU_API_KEY - overwrite api_key in the config.
  • KITSU_API_URL - overwrite api_url in the config.

Kitsunekko mirror

kitsunekko-mirror is a git repository with Japanese anime subtitles.