StreamingCommunity 1.8.0__tar.gz → 1.9.2__tar.gz

StreamingCommunity-1.9.2/PKG-INFO

@@ -0,0 +1,426 @@
+Metadata-Version: 2.1
+Name: StreamingCommunity
+Version: 1.9.2
+Summary: UNKNOWN
+Home-page: https://github.com/Lovi-0/StreamingCommunity
+Author: Lovi-0
+License: UNKNOWN
+Project-URL: Bug Reports, https://github.com/Lovi-0/StreamingCommunity/issues
+Project-URL: Source, https://github.com/Lovi-0/StreamingCommunity
+Description: # StreamingCommunity Downloader 🎬
+        
+        ![Project Logo](https://i.ibb.co/f4h5Y2m/min-logo.png)
+        
+        A versatile script designed to download films and series from various supported streaming platforms.
+        
+        # 🤝 Join our Community 
+        
+        Chat, contribute, and have fun in our **Git_StreamingCommunity** Discord [Server](https://discord.com/invite/8vV68UGRc7)
+        
+        # 📋 Table of Contents
+        
+        - [Website available](#website-status)
+        - [Installation](#installation)
+            - [PyPI Installation](#1-pypi-installation)
+            - [Automatic Installation](#2-automatic-installation)
+            - [Manual Installation](#3-manual-installation)
+                - [Win 7](https://github.com/Ghost6446/StreamingCommunity_api/wiki/Installation#win-7)
+                - [Termux](https://github.com/Ghost6446/StreamingCommunity_api/wiki/Termux)
+        - [Configuration](#configuration)
+            - [Default](#default-settings)
+            - [Request](#requests-settings)
+            - [Browser](#browser-settings)
+            - [Download](#m3u8_download-settings)
+            - [Parser](#m3u8_parser-settings)
+        - [Docker](#docker)
+        - [Tutorial](#tutorials)
+        - [To Do](#to-do)
+        
+        
+        
+        # Installation
+        
+        ## 1. PyPI Installation
+        
+        Install directly from PyPI:
+        
+        ```bash
+        pip install StreamingCommunity
+        ```
+        
+        ### Creating a Run Script
+        
+        Create `run_streaming.py`:
+        
+        ```python
+        from StreamingCommunity.run import main
+        
+        if __name__ == "__main__":
+            main()
+        ```
+        
+        Run the script:
+        ```bash
+        python run_streaming.py
+        ```
+        
+        ## Updating via PyPI
+        
+        ```bash
+        pip install --upgrade StreamingCommunity
+        ```
+        
+        ## 2. Automatic Installation
+        
+        ### Supported Operating Systems 💿
+        
+        | OS              | Automatic Installation Support |
+        |:----------------|:------------------------------:|
+        | Windows 10/11   |              ✔️              |
+        | Windows 7       |              ❌              |
+        | Debian Linux    |              ✔️              |
+        | Arch Linux      |              ✔️              |
+        | CentOS Stream 9 |              ✔️              |
+        | FreeBSD         |              ⏳              |
+        | MacOS           |              ✔️              |
+        | Termux          |              ❌              |
+        
+        ### Installation Steps
+        
+        #### On Windows:
+        
+        ```powershell
+        .\win_install.bat
+        ```
+        
+        #### On Linux/MacOS/BSD:
+        
+        ```bash
+        sudo chmod +x unix_install.sh && ./unix_install.sh
+        ```
+        
+        ### Usage
+        
+        #### On Windows:
+        
+        ```powershell
+        python .\test_run.py
+        ```
+        
+        or
+        
+        ```powershell
+        source .venv/bin/activate && python test_run.py && deactivate
+        ```
+        
+        #### On Linux/MacOS/BSD:
+        
+        ```bash
+        ./test_run.py
+        ```
+        
+        ## 3. Manual Installation
+        
+        ### Requirements 📋
+        
+        Prerequisites:
+        * [Python](https://www.python.org/downloads/) > 3.8
+        * [FFmpeg](https://www.gyan.dev/ffmpeg/builds/)
+        
+        ### Install Python Dependencies
+        
+        ```bash
+        pip install -r requirements.txt
+        ```
+        
+        ### Usage
+        
+        #### On Windows:
+        
+        ```powershell
+        python test_run.py
+        ```
+        
+        #### On Linux/MacOS:
+        
+        ```bash
+        python3 test_run.py
+        ```
+        
+        ## Update
+        
+        Keep your script up to date with the latest features by running:
+        
+        ### On Windows:
+        
+        ```powershell
+        python update.py
+        ```
+        
+        ### On Linux/MacOS:
+        
+        ```bash
+        python3 update.py
+        ```
+        
+        <br>
+        
+        # Configuration
+        
+        You can change some behaviors by tweaking the configuration file.
+        
+        The configuration file is divided into several main sections:
+        
+        ## DEFAULT Settings
+        
+        ```json
+        {
+            "root_path": "Video",
+            "movie_folder_name": "Movie",
+            "serie_folder_name": "TV",
+            "map_episode_name": "%(tv_name)_S%(season)E%(episode)_%(episode_name)",
+            "not_close": false,
+            "show_trending": false
+        }
+        ```
+        
+        - `root_path`: Directory where all videos will be saved
+        
+          ### Path examples:
+          * Windows: `C:\\MyLibrary\\Folder` or `\\\\MyServer\\MyLibrary` (if you want to use a network folder)
+          * Linux/MacOS: `Desktop/MyLibrary/Folder`
+            `<br/><br/>`
+        
+        - `movie_folder_name`: The name of the subdirectory where movies will be stored.
+        - `serie_folder_name`: The name of the subdirectory where TV series will be stored.
+        
+        - `map_episode_name`: Template for TV series episode filenames
+        
+          ### Episode name usage:
+        
+          You can choose different vars:
+        
+        
+          * `%(tv_name)` : Is the name of TV Show
+          * `%(season)` : Is the number of the season
+          * `%(episode)` : Is the number of the episode
+          * `%(episode_name)` : Is the name of the episode
+            `<br/><br/>`
+            
+        - `not_close`: If true, continues running after downloading
+        - `show_trending`: Display trending content on startup
+        
+            ### qBittorrent Configuration
+        
+            ```json
+            {
+                "config_qbit_tor": {
+                    "host": "192.168.1.59",
+                    "port": "8080",
+                    "user": "admin",
+                    "pass": "adminadmin"
+                }
+            }
+            ```
+        
+            To enable qBittorrent integration, follow the setup guide [here](https://github.com/lgallard/qBittorrent-Controller/wiki/How-to-enable-the-qBittorrent-Web-UI).
+        
+        <br>
+        
+        ## REQUESTS Settings
+        
+        ```json
+        {
+            "timeout": 20,
+            "max_retry": 3
+        }
+        ```
+        
+        - `timeout`: Maximum timeout (in seconds) for each request
+        - `max_retry`: Number of retry attempts per segment during M3U8 index download
+        
+        <br>
+        
+        ## BROWSER Settings
+        
+        ```json
+        {
+            "headless": false
+        }
+        ```
+        
+        - `headless`: Controls whether to run browser in headless mode
+        
+        <br>
+        
+        ## M3U8_DOWNLOAD Settings
+        
+        ```json
+        {
+            "tqdm_delay": 0.01,
+            "tqdm_use_large_bar": true,
+            "default_video_workser": 12,
+            "default_audio_workser": 12,
+            "cleanup_tmp_folder": true
+        }
+        ```
+        
+        - `tqdm_delay`: Delay between progress bar updates
+        - `tqdm_use_large_bar`: Use detailed progress bar (recommended for desktop) set to false for mobile
+        - `default_video_workser`: Number of threads for video download
+        - `default_audio_workser`: Number of threads for audio download
+        - `cleanup_tmp_folder`: Remove temporary .ts files after download
+        
+        
+        <br>
+        
+        ### Language Settings
+        
+        The following codes can be used for `specific_list_audio` and `specific_list_subtitles`:
+        
+        ```
+        ara - Arabic       eng - English      ita - Italian     por - Portuguese
+        baq - Basque       fil - Filipino     jpn - Japanese    rum - Romanian
+        cat - Catalan      fin - Finnish      kan - Kannada     rus - Russian
+        chi - Chinese      fre - French       kor - Korean      spa - Spanish
+        cze - Czech        ger - German       mal - Malayalam   swe - Swedish
+        dan - Danish       glg - Galician     may - Malay       tam - Tamil
+        dut - Dutch        gre - Greek        nob - Norw. Bokm  tel - Telugu
+                           heb - Hebrew       nor - Norwegian    tha - Thai
+        forced-ita         hin - Hindi        pol - Polish      tur - Turkish
+                           hun - Hungarian                       ukr - Ukrainian
+                           ind - Indonesian                      vie - Vietnamese
+        ```
+        
+        > [!IMPORTANT]
+        > Language code availability may vary by site. Some platforms might:
+        >
+        > - Use different language codes
+        > - Support only a subset of these languages
+        > - Offer additional languages not listed here
+        >
+        > Check the specific site's available options if downloads fail.
+        
+        > [!TIP]
+        > You can configure multiple languages by adding them to the lists:
+        >
+        > ```json
+        > "specific_list_audio": ["ita", "eng", "spa"],
+        > "specific_list_subtitles": ["ita", "eng", "spa"]
+        > ```
+        
+        ## M3U8_PARSER Settings
+        
+        ```json
+        {
+            "force_resolution": -1,
+            "get_only_link": false
+        }
+        ```
+        
+        - `force_resolution`: Force specific resolution (-1 for best available, or specify 1080, 720, 360)
+        - `get_only_link`: Return M3U8 playlist/index URL instead of downloading
+        
+        <br>
+        
+        
+        # COMMAND
+        
+        
+        - Download a specific season by entering its number.
+          *  **Example:** `1` will download *Season 1* only.
+        
+        -  Use the wildcard `*` to download every available season.
+           * **Example:** `*` will download all seasons in the series.
+        
+        - Specify a range of seasons using a hyphen `-`.
+           * **Example:** `1-2` will download *Seasons 1 and 2*.
+        
+        - Enter a season number followed by `-*` to download from that season to the end.
+          * **Example:** `3-*` will download from *Season 3* to the final season.
+        
+        <br>
+        
+        # Docker
+        
+        You can run the script in a docker container, to build the image just run
+        
+        ```
+        docker build -t streaming-community-api .
+        ```
+        
+        and to run it use
+        
+        ```
+        docker run -it -p 8000:8000 streaming-community-api
+        ```
+        
+        By default the videos will be saved in `/app/Video` inside the container, if you want to to save them in your machine instead of the container just run
+        
+        ```
+        docker run -it -p 8000:8000 -v /path/to/download:/app/Video streaming-community-api
+        ```
+        
+        ### Docker quick setup with Make
+        
+        Inside the Makefile (install `make`) are already configured two commands to build and run the container:
+        
+        ```
+        make build-container
+        
+        # set your download directory as ENV variable
+        make LOCAL_DIR=/path/to/download run-container
+        ```
+        
+        The `run-container` command mounts also the `config.json` file, so any change to the configuration file is reflected immediately without having to rebuild the image.
+        
+        # Website Status 
+        
+        | Website            | Status |
+        |:-------------------|:------:|
+        | 1337xx             |   ✅   |
+        | Altadefinizione    |   ✅   |
+        | AnimeUnity         |   ✅   |
+        | BitSearch          |   ✅   |
+        | CB01New            |   ✅   |
+        | DDLStreamItaly     |   ✅   |
+        | GuardaSerie        |   ✅   |
+        | MostraGuarda       |   ✅   |
+        | PirateBays         |   ✅   |
+        | StreamingCommunity |   ✅   |
+        
+        # Tutorials 
+        
+        - [Windows Tutorial](https://www.youtube.com/watch?v=mZGqK4wdN-k)
+        - [Linux Tutorial](https://www.youtube.com/watch?v=0qUNXPE_mTg)
+        - [Pypy Tutorial](https://www.youtube.com/watch?v=C6m9ZKOK0p4)
+        - [Compiled .exe Tutorial](https://www.youtube.com/watch?v=pm4lqsxkTVo)
+        
+        # To Do 
+        
+        - Create website API -> https://github.com/Lovi-0/StreamingCommunity/tree/test_gui_1
+        
+        # SUPPORT
+        
+        If you'd like to support this project, consider making a donation!
+        
+        [![Donate](https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif)](https://www.paypal.com/donate/?hosted_button_id=UXTWMT8P6HE2C)
+        
+        # Contributing
+        
+        Contributions are welcome! Steps:
+        1. Fork the repository
+        2. Create feature branch (`git checkout -b feature/AmazingFeature`)
+        3. Commit changes (`git commit -m 'Add some AmazingFeature'`)
+        4. Push to branch (`git push origin feature/AmazingFeature`)
+        5. Open Pull Request
+        
+        
+        # Disclaimer
+        
+        This software is provided "as is", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages, or other liability, whether in an action of contract, tort, or otherwise, arising from, out of, or in connection with the software or the use or other dealings in the software.
+        
+Keywords: streaming community
+Platform: UNKNOWN
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown