anipy-cli 3.3.2__py3-none-any.whl → 3.3.4__py3-none-any.whl

anipy_cli/__init__.py

@@ -1,2 +1,2 @@
 __appname__ = "anipy-cli"
-__version__ = "3.3.2"
+__version__ = "3.3.4"

anipy_cli/clis/download_cli.py

@@ -69,7 +69,7 @@ class DownloadCli(CliBase):
         assert self.anime is not None
         assert self.lang is not None
 
-        errors = DownloadComponent(self.options, self.dl_path).download_anime(
+        errors = DownloadComponent(self.options, self.dl_path, "download").download_anime(
             [(self.anime, self.lang, self.episodes)], only_skip_ep_on_err=True
         )
         DownloadComponent.serve_download_errors(errors, only_skip_ep_on_err=True)

anipy_cli/config.py

@@ -85,7 +85,6 @@ class Config:
         defaults = {
             "default": ["anivibe"],
             "download": ["anivibe"],
-            "history": ["anivibe"],
             "seasonal": ["anivibe"],
             "binge": ["anivibe"],
             "mal": ["anivibe"],
@@ -223,6 +222,47 @@ class Config:
         )
         return str(Path(value).with_suffix(""))
 
+    @property
+    def post_download_scripts(self) -> Dict[str, List[str]]:
+        """With this option you can define scripts that run after a file
+        has been downloaded. As with the 'providers' option, you can configure
+        different behaviour, depending on which part of anipy-cli the download occurs.
+        Configurable areas are as follows: default (and history), download (-D), seasonal (-S)
+        and mal (-M). The example will show you how it is done! Please note that if you define 
+        several scripts for one area, they will run in the order you put them in the list.
+        You can also define a timeout (in seconds), after which a script will be terminated,
+        if set to null there will be no timeout and any script will run forever.
+
+        A "script" is a path to an executable file which accepts following parameters (in this order):
+            1. Path to the file
+            2. Name of series
+            3. Episode
+            4. Provider
+            5. Quality
+            6. Language profile
+
+        Examples:
+            post_download_scripts:
+                default: [] # used in default mode and for the history
+                download: ["/scripts/send_notification.sh", "/scripts/move_and_rename.sh"]
+                seasonal: ["link_to_jellyfin.bat", "jellyfin_library_update.exe"] # All executable files should work, including windows specific
+                mal: ["hard_link_to_shoko"]
+                timeout: 60 # terminate any script after running for 60 seconds
+        """
+        defaults = {
+            "default": [],
+            "download": [],
+            "seasonal": [],
+            "mal": [],
+            "timeout": None
+        }
+
+        value = self._get_value("post_download_scripts", defaults, dict)
+
+        # Merge Dicts
+        defaults.update(value)
+        return defaults
+
     @property
     def dc_presence(self) -> bool:
         """Activate discord presence, only works with discord open."""

anipy_cli/download_component.py

@@ -3,7 +3,7 @@ from typing import List, Protocol, Tuple
 from anipy_cli.arg_parser import CliArgs
 from anipy_cli.colors import color, colors
 from anipy_cli.config import Config
-from anipy_cli.util import DotSpinner, get_download_path
+from anipy_cli.util import DotSpinner, get_download_path, get_post_download_scripts_hook
 
 from anipy_api.anime import Anime
 from anipy_api.download import Downloader
@@ -31,9 +31,10 @@ class DownloadComponent:
     the ani-py CLI.
     """
 
-    def __init__(self, cliArgs: CliArgs, dl_path: Path) -> None:
-        self.options = cliArgs
+    def __init__(self, options: CliArgs, dl_path: Path, mode: str) -> None:
+        self.options = options 
         self.dl_path = dl_path
+        self.mode = mode
 
     def download_anime(
         self,
@@ -142,6 +143,7 @@ class DownloadComponent:
             get_download_path(anime, stream, parent_directory=self.dl_path),
             container=config.remux_to,
             ffmpeg=self.options.ffmpeg or config.ffmpeg_hls,
+            post_dl_cb=get_post_download_scripts_hook(self.mode, anime, spinner)
         )
 
     @staticmethod

anipy_cli/menus/mal_menu.py

@@ -270,7 +270,7 @@ class MALMenu(MenuBase):
                 episode=int(ep),
             )
 
-        errors = DownloadComponent(self.options, self.dl_path).download_anime(
+        errors = DownloadComponent(self.options, self.dl_path, "mal").download_anime(
             new_picked, on_successful_download
         )
         DownloadComponent.serve_download_errors(errors)

anipy_cli/menus/menu.py

@@ -10,7 +10,7 @@ from anipy_api.locallist import LocalList
 from anipy_cli.colors import colors, cprint
 from anipy_cli.config import Config
 from anipy_cli.menus.base_menu import MenuBase, MenuOption
-from anipy_cli.util import DotSpinner, error, get_download_path, migrate_locallist
+from anipy_cli.util import DotSpinner, error, get_download_path, get_post_download_scripts_hook, migrate_locallist
 from anipy_cli.prompts import pick_episode_prompt, search_show_prompt
 
 
@@ -233,6 +233,7 @@ class Menu(MenuBase):
                 get_download_path(self.anime, self.stream),
                 container=config.remux_to,
                 ffmpeg=self.options.ffmpeg or config.ffmpeg_hls,
+                post_dl_cb=get_post_download_scripts_hook("default", self.anime, s)
             )
 
         if Config().auto_open_dl_defaultcli:

anipy_cli/menus/seasonal_menu.py

@@ -270,7 +270,7 @@ class SeasonalMenu(MenuBase):
         def on_successful_download(anime: Anime, ep: Episode, lang: LanguageTypeEnum):
             self.seasonal_list.update(anime, episode=ep, language=lang)
 
-        failed_series = DownloadComponent(self.options, self.dl_path).download_anime(
+        failed_series = DownloadComponent(self.options, self.dl_path, "seasonal").download_anime(
             picked, on_successful_download
         )
 

anipy_cli/util.py

@@ -1,8 +1,10 @@
 import sys
 import time
+import subprocess as sp
 from pathlib import Path
 from typing import (
     TYPE_CHECKING,
+    Callable,
     Iterator,
     List,
     Literal,
@@ -13,7 +15,7 @@ from typing import (
 )
 
 from anipy_api.anime import Anime
-from anipy_api.download import Downloader
+from anipy_api.download import Downloader, PostDownloadCallback
 from anipy_api.error import LangTypeNotAvailableError
 from anipy_api.locallist import LocalListData, LocalListEntry
 from anipy_api.player import get_player
@@ -119,6 +121,24 @@ def get_download_path(
 
     return download_folder / anime_name / filename
 
+def get_post_download_scripts_hook(mode: str, anime: "Anime", spinner: DotSpinner) -> PostDownloadCallback:
+    config = Config()
+    scripts = config.post_download_scripts[mode]
+    timeout = config.post_download_scripts["timeout"]
+
+    def hook(path: Path, stream: "ProviderStream"):
+        spinner.hide()
+        arguments = [
+            str(path), anime.name,
+            str(stream.episode), anime.provider.NAME,
+            str(stream.resolution), stream.language.name
+        ]
+        for s in scripts:
+            sub_proc = sp.Popen([s, *arguments])
+            sub_proc.wait(timeout) # type: ignore
+        spinner.show()
+
+    return hook
 
 def parse_episode_ranges(ranges: str, episodes: List["Episode"]) -> List["Episode"]:
     picked = set()

{anipy_cli-3.3.2.dist-info → anipy_cli-3.3.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: anipy-cli
-Version: 3.3.2
+Version: 3.3.4
 Summary: Watch and Download anime from the comfort of your Terminal
 Home-page: https://sdaqo.github.io/anipy-cli
 License: GPL-3.0
@@ -15,7 +15,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: anipy-api (>=3.3.2,<4.0.0)
+Requires-Dist: anipy-api (>=3.3.4,<4.0.0)
 Requires-Dist: appdirs (>=1.4.4,<2.0.0)
 Requires-Dist: inquirerpy (>=0.3.4,<0.4.0)
 Requires-Dist: pypresence (>=4.3.0,<5.0.0)

{anipy_cli-3.3.2.dist-info → anipy_cli-3.3.4.dist-info}/RECORD

@@ -1,27 +1,27 @@
-anipy_cli/__init__.py,sha256=cQA-dU0vjujboVvKU3NJliD0rtmYEn5kRgzyR4YMb1o,48
+anipy_cli/__init__.py,sha256=S3uHlqaqwDVDsjRxtpyGtKztgf9jrVf3CtG8pj149ZU,48
 anipy_cli/arg_parser.py,sha256=Y_p5Sh7LR0yeqfhFVXkyAbZMjDR1-NIoY_TVuPwUnwk,6009
 anipy_cli/cli.py,sha256=Ah5BE-u_SjcuzU5dQ5cSHtUloVRApCWwTK5i49yQtH8,1922
 anipy_cli/clis/__init__.py,sha256=Y00uiPWiMvvRImxJMvfLA55BOkMUOrrx5vJUNvquNsY,411
 anipy_cli/clis/base_cli.py,sha256=xPr_J8hKs7LkDLvmK6zyL1ZTZRpyC2IuFss8KsaDstU,817
 anipy_cli/clis/binge_cli.py,sha256=ioZ-V0WfGYBqETFkd8epGrT9dPHwsRJ1qvIdqf4waIs,2551
 anipy_cli/clis/default_cli.py,sha256=aJrJwtwdD7l-Z3dMjSHlvMvgTVnwA3_OXwS-9DZQIy8,3078
-anipy_cli/clis/download_cli.py,sha256=ku4_zVMeiV7VOxEx2Bq0mhxQJfS5sculzewgBfYuuFE,2308
+anipy_cli/clis/download_cli.py,sha256=K8hqkxTeQ5Ao5LR2rimxX099IWf2I_KDGySIZzuIIVI,2320
 anipy_cli/clis/history_cli.py,sha256=2ccv6BpQQpUhY4K-KM7lO9qxVLXBrmCY5lec6czipSE,2863
 anipy_cli/clis/mal_cli.py,sha256=_tSLgDUOa6GOZNyCncSSzaVj088y5GAKkHVRSndLLxk,2258
 anipy_cli/clis/seasonal_cli.py,sha256=GV2TQNm9UotG1cxfYbrFFgg7Jmy8SFa7w_GlFtPdRVE,616
 anipy_cli/colors.py,sha256=voXC7z1Fs9tHg4zzNTNMIrt9k-EVgJ3_xEf5KiW2xgo,916
-anipy_cli/config.py,sha256=tVZk51QuX4V4BOIzyDYdQ6y6QKU69NkagAYXhcikHXY,15934
+anipy_cli/config.py,sha256=mbR7D1472Z6lLLw1_Vx_H0cH7fQVJJBPpIVXA6SMvy0,17751
 anipy_cli/discord.py,sha256=c6mdqnEdblzZBYs3cGP66oDeS4ySm59OfTRP-R-Duls,1160
-anipy_cli/download_component.py,sha256=6N-7ItCj1hiqFu7falu6gvLp5KNYtfISMqlazHFPiAg,5098
+anipy_cli/download_component.py,sha256=3GCPoWIEjhN1rBtOt8NQg9lqBTI4OHV3gG2RZ3NMzcA,5248
 anipy_cli/mal_proxy.py,sha256=me2ESB442pYeNEpHY8mqrOEb477UA0uAg2LprKcp8sM,7098
 anipy_cli/menus/__init__.py,sha256=aIzbphxAW-QGfZwR1DIegFZuTJp1O3tSUnai0f0f4lY,185
 anipy_cli/menus/base_menu.py,sha256=g5b9Z7SpvCxcq_vqObcPzxLwcXeGPltLgSwa0sEzyfk,1140
-anipy_cli/menus/mal_menu.py,sha256=RBq80HG-rKUeJaDuT9ZCCZuujebb2Jc0xwo2Pedo3VQ,23690
-anipy_cli/menus/menu.py,sha256=iSEko3ckcLMOccwB8qJ2LE4j15Qgy0RMLWKY9jnAJrY,7985
-anipy_cli/menus/seasonal_menu.py,sha256=t4LJMtempxf3OaqtOvGJoRJ1IhmxgFjsIgeSceKKnR4,10636
+anipy_cli/menus/mal_menu.py,sha256=jAVJh7K5d0BCnoT4qUIZ7CavrnrctXj-eg9k8E90ulE,23697
+anipy_cli/menus/menu.py,sha256=ejTOGVG8fFJhTT7t23kA_uBbF5pkNcdvj4cGAIPvdt8,8101
+anipy_cli/menus/seasonal_menu.py,sha256=diABjK7LIDlXUoMydhDyLG9ba7J4UFmeD5AyGO3GPAI,10648
 anipy_cli/prompts.py,sha256=lQDrb8IlhsQhOpLG4sflamprTSn-PlCy41tGpXIowdo,10156
-anipy_cli/util.py,sha256=Y_kPyb3D0-lVipWIJFL3GNcnunSlQw4kNTzCzgRXOQg,8232
-anipy_cli-3.3.2.dist-info/METADATA,sha256=TLuUZt_l919y8gi2Myv8D6zsq_oTt_n-HdjMF2RfsZo,3469
-anipy_cli-3.3.2.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-anipy_cli-3.3.2.dist-info/entry_points.txt,sha256=86iXpcm_ECFndrt0JAI2mqYfXC2Ar7mGi0iOaxCrNP0,51
-anipy_cli-3.3.2.dist-info/RECORD,,
+anipy_cli/util.py,sha256=PxUPRxKCCTig1IHwmzH4m4Jofr4r-bg9lHyID3l5CIA,8944
+anipy_cli-3.3.4.dist-info/METADATA,sha256=WzPCCp1Uy-mTM6Gu2D1JlLD6qVKX8VlcTOFNtllkrO4,3469
+anipy_cli-3.3.4.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+anipy_cli-3.3.4.dist-info/entry_points.txt,sha256=86iXpcm_ECFndrt0JAI2mqYfXC2Ar7mGi0iOaxCrNP0,51
+anipy_cli-3.3.4.dist-info/RECORD,,