Vai al contenuto

Contributing

Server

Questa sezione spiega come aggiungere alla libreria la possibilità di scaricare un episodio da un altro server non ancora supportato.

Server
✔️ AnimeWorld_Server ❌ StreamHide ❌ Doodstream
✔️ Streamtape ❌ FileMoon ❌ StreamSB
✔️ YouTube ❌ Streamtape ❌ Streamlare

Per aggiungere un nuovo server basta seguire questi passi:

  1. Creare un file .py con il nome del server e metterlo nella cartella servers. (es NuovoServer.py)

  2. Usa questo template per la classe del nuovo server:

    NuovoServer.py
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
    from .Server import *

class NuovoServer(Server):
    def fileLink(self): # Obbligatoria
        """
        Recupera il link diretto per il download del file dell'episodio.

        Returns:
          Link diretto.

        Example:
          ```py
          return str # Link del file
          ```
        """
        pass #TODO: da completare

    def fileInfo(self) -> Dict[str,str]: # Opzionale
        """
        Recupera le informazioni del file dell'episodio.

        Returns:
          Informazioni file episodio.

        Example:
          ```py
          return {
            "content_type": str, # Tipo del file, es. video/mp4
            "total_bytes": int, # Byte totali del file
            "last_modified": datetime, # Data e ora dell'ultimo aggiornamento effettuato all'episodio sul server
            "server_name": str, # Nome del server
            "server_id": int, # ID del server
            "url": str # url dell'episodio
          } 
          ```
        """
        pass #TODO: da completare

    def download(self, title: Optional[str]=None, folder: str='', *, hook: Callable[[Dict], None]=lambda *args:None, opt: List[str]=[]) -> Optional[str]: # Obbligatoria
        """
        Scarica l'episodio.

        Args:
          title: Nome con cui verrà nominato il file scaricato.
          folder: Posizione in cui verrà spostato il file scaricato.

        Other parameters:
          hook: Funzione che viene richiamata varie volte durante il download; la funzione riceve come argomento un dizionario con le seguenti chiavi:\n 
            - `total_bytes`: Byte totali da scaricare.
            - `downloaded_bytes`: Byte attualmente scaricati.
            - `percentage`: Percentuale del progresso di download.
            - `speed`: Velocità di download (byte/s)
            - `elapsed`: Tempo trascorso dall'inizio del download.
            - `eta`: Tempo stimato rimanente per fine del download.
            - `status`: 'downloading' | 'finished' | 'aborted'
            - `filename`: Nome del file in download.

          opt: Lista per delle opzioni aggiuntive.\n
            - `'abort'`: Ferma forzatamente il download.

        Returns:
          Nome del file scaricato. 

        Raises:
          HardStoppedDownload: Il file in download è stato forzatamente interrotto.

        Example:
          ```py
          return str # File scaricato
          ```
        """
        if title is None: title = self._defTitle
        else: title = self._sanitize(title)

        pass

        #TODO: da completare, selezionare uno dei 2 metodi:
        # #NOTE: da usare se il file puó essere scaricato semplicemente con httpx:
        # return self._downloadIn(title,folder,hook=hook,opt=opt) 
        #
        # #NOTE: da usare se il file deve essere scaricato usando la libreria youtube_dl
        # return self._dowloadEx(title,folder,hook=hook,opt=opt)

  3. Completare le varie funzioni (quelle segnate con Opzionale possono anche non essere completate), prendendo anche spunto dai vari server caricati nella cartella.

  4. Aggiungi la linea from .NuovoServer import NuovoServer al file servers/init.py.

  5. Modificare il file episodio.py aggiungendo il nome del server tra gli import (Linea 12) e modificare la funzione __setServer.

Se tutto funziona correttamente apri una richiesta di pull.

Ultimo aggiornamento: November 18, 2023