animethemes-dl 2.1.0

Downloads anime themes from animethemes.moe. Supports Batch download and MAL/AniList connecting.

animethemes-dl

what's this project

This project allows you to automaticaly download opening and ending songs from all of your favorite anime without the need of downloading everything yourself. Since almost every weeb uses MAL to track the anime he's watching, this tool is really useful, as every information you need to give it has been written down already. All you need to do is to enter your MAL or AniList username.

disclaimer

All videos are downloaded from animethemes.moe. If you plan on using this program just for looking at openings, I recommend using themes.moe instead. This program is made for creating your own playlist and such.

what's this project for

This project was made for batch downloading themes from anime you have watched, but is programmed so it's easily improved, making it possible to add very easily. It's made with both command line usage and with python as a module.

how to install

• clone this repository from github.com or download it from pip with pip install animethemes-dl
• if you cloned, do pip install -r requirements.txt to install all required modules
• install ffmpeg into the same folder or in PATH

usage in command line

make sure you have ffmpeg and python installed possible commands: animethemes-dl.bat in windows, animethemes-dl.sh in linux. animethemes-dl if installed with pip. python -m animethemes-dl with python.

All of these commands will be reffered to as animethemes-dl in the documentation.

command line documentation

The script should raise errors in case you pass in an improper arg, but sometimes an error won't be raised if the error is not obvious, therefore make sure you read the documentation before running it.

You must set a username and a save folder.

animelist

You must set a username. By default usernames are assumed to be a MAL user, you can use anilist instead with --anilist.

--animelist-args can be:

• url args for MAL ``
• query and variables for POST request for AniList

--animelist-args are passed as a <key>:<value> pairs, for example: sort1=1,sort2=14

animelist filters

There are filters for minimum score and priority.

--minscore is the minimum score between 0 and 10. --minpriority is the minimum priority. For mal, use Low=0,Medium=1,High=2

tag filters

You can set --banned-tags or --required-tags. These will take multiple tags, possible tags are:

Tag	Meaning
spoiler	Video contains spoilers.
nsfw	Video is NSFW.
nc	No captions/no credits.
subbed	Video includes English subtitles of dialogue.
lyrics	Video includes English lyrics as subtitles.
uncen	Video does not have censorship.

You can set a --min-resolution, they show up in 420,720,1080.

You can set the required --source, possible sources are:

Source	Meaning
BD	Video is sourced from a Blu-ray disc.
DVD	Video is sourced from a DVD.
	Video is sourced from a TV release.

Some themes contain dialogue (which I personally don't want). You can set a --banned-over lap, that will not show up anymore, possible overlaps are:

Overlap	Meaning
Over	Part of episode is over the video.
Transition	Part of episode transitions into the video.
None	No dialogue in video.

Transitions are fairly fine, they don't even have dialogue most of the time, I recommend just banning Over

download

Downloads are by default disabled for both video and audio. You can enable it by setting a save folder. Save folders are set with -a (audio) and -v (video).

The filename format can be changed with --filename.

The possible formats are defined in this table:

Format	Meaning
anime_id	Animethemes' id of anime.
anime_name	Name of Anime.
anime_slug	Animethemes' slug of anime.
anime_year	Year the anime came out.
anime_season	Season the anime came out.
theme_id	Animethemes' id of theme.
theme_type	Type of theme (OP/ED).
theme_sequence	Sequence of theme.
theme_group	Group of theme (e.g. language).
theme_slug	Animethemes' slug of theme (type+sequence).
entry_id	Animethemes' id of entry.
entry_version	Version of entry ("" or 1+).
entry_notes	Notes of entry (e.g. SFX version).
video_id	Animethemes' id of video.
video_basename	Animethemes' basename of video.
video_filename	Basename without the filetype.
video_size	Size of file in bytes.
video_resolution	Resolution of video.
video_source	Where the video was sourced from.
video_overlap	Episode overlap over video.
song_id	Animethemes' id of song.
song_title	Title of song.
video_filetype	Filetype of video.
anime_filename	Name of anime used in filenames.

formats should be used as a python format string, meaning that it will be put as %(format)s. For example %(anime_filename)s-%(theme_slug)s.%(video_filetype)s.

Windows and Linux banned characters will be removed by default, to remove those and also unicode characters use --ascii

You can disable redownloading with -r. This is highly recommended. If you have downloaded video you can --update theme, this will check file validity by looking at the filesize. It will also update audio files if the video is downloaded.

You can add a coverart to audio files with --coverart, --coverart takes in a resolution, if set, image will be fetched from anilist.co, with high resolutions it's recommended to save them in --coverart-folder.

Downloader timeout can be changed with --timeout and max amount of retries with --retries.

Sometimes when using filters a video that you wanted gets filtered out. you can --force-videos and keep them this way.

re:zero for example has lots of unique EDs, they have an episode in the background, but like 2 of them have no dialogue, which is fine keeping imo.

statuses

You can download anime that you have --on-hold,--dropped or --planned.

compression

Downloaded files can be compressed in case you want to save them.

It will be enabled by setting a directory you want to compress with --compress-dir, this should be the same directory as you chosen one. The destination file is set with --compress-name, set it without the extension. You can choose the --compress-format, this must be a format allowed by shutils.make_archive.

Additionally you can set the --compress-base.

printing

You can set the loglevel with --loglevel. This will set the logging.setLevel(x*10). There are quick commands --quiet (print none) and --verbose (print all). To restrict download and ffmpeg messages, you MUST use --quiet.

You can disable color with --no-color.

utilities

In case you haven't added ffmpeg to path, you can set the path with --ffmpeg.

You can --repair in case the script made some errors or you picked wrong options. This will delete unexpected files and readd metadata.

settings

You can load options from a file with --options, the file is in json format.

The default options are:

{
    "animelist": {
        "username": "",
        "anilist": false,
        "animelist_args": {},
        "minpriority": 0,
        "minscore": 0
    },
    "filter": {
        "spoilers": true,
        "nsfw": true,
        "nocredits": false,
        "lyrics": false,
        "bluray": false,
        "DVD": false,
        "1080": false,
        "480": false
    },
    "download": {
        "filename": "%(short_anime_title)s-%(type)s.%(filetype)s",
        "audio_folder": null,
        "video_folder": null,
        "no_redownload": false,
        "ascii": false,
        "timeout": 5,
        "retries": 3,
        "sort": null,
        "coverart": {
            "resolution": 0,
            "folder": null
        },
        "compression": {
            "root_dir": null,
            "base_name": "animethemes",
            "format": "tar",
            "base_dir": null
        }
    },
    "statuses": [1,2],
    "quiet": false,
    "no_colors": false,
    "ffmpeg": "ffmpeg",
    "ignore_prompts": false
}

You can generate the options with python -m animethemes_dl.models.options.

code documentation

The code uses the module models that contains models of typing.TypedDict. Meaning python 3.8 is required. Module parsers contains all parsers for MAL, Anilist and themes.moe. Module tools contains extra tools for animethemes-dl.

examples:

# parsers module uses API's to get data
import animethemes_dl.parsers as parsers
parsers.get_themes(username) # gets raw data
parsers.get_download_data(username) # gets download data

# models module uses typedDict to help language servers
import animethemes_dl.models as models
animelist: RawAnimeList = _myanimefunc()
metadata: Metadata = _mymetadatafunc2()

# tools have multiple tools used for several stuff
import animethemes_dl.tools as tools
tools.ffmpeg_covert(webm_file,mp3_file) # converts a webm file
tools.COLORS['progress'] = Fore.CYAN # changes colors
tools.compress_files(base,'zip',root) # compresses a direcotory
tools.update_metadata(
  parsers.get_download_data(username),False
) # updates metadata of all audio files

# you can implement your own batch dl
import animethemes_dl
data = parsers.get_download_data(username)
for theme in data:
  animethemes_dl.download_themes(theme,True)

# you can directly change options
animethemes_dl.setOptions(options)

# you can make special catchers
import animethemes_dl.errors as errors
try:
  animethemes_dl.batch_download(data)
except FfmpegException:
  print('I have no idea what happened')

how does it work?

• parser
  • get data from MAL/AniList
  • get data from themes.moe
  • combine data
  • filter out unwanted themes
  • create download data
• download
  • download video file
  • convert video to audio
    • convert with ffmpeg
    • add mp3 metadata
• optional
  • compress files

TODO

• code optimizations
• improve code documentation
• add metadata for DICS, TRACK NO., COMMENT, SCORE, COPYRIGHT, LANGUAGE, STUDIO, FEATUERD ARTISTS