Project Logo

PyPI Donate Commits Last Commit

License PyPI Downloads Lines of Code

# 📋 Table of Contents
đŸ“Ļ Installation - 🔄 [Update Domains](#update-domains) - 🌐 [Available Sites](https://arrowar.github.io/StreamingCommunity/) - 🛠ī¸ [Installation](#installation) - đŸ“Ļ [PyPI Installation](#1-pypi-installation) - 🔄 [Automatic Installation](#2-automatic-installation) - 🔧 [Binary Location](#binary-location) - 📝 [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 & Usage - ⚙ī¸ [Configuration](#configuration) - 🔧 [Default](#default-settings) - 📩 [Request](#requests-settings) - đŸ“Ĩ [Download](#m3u8_download-settings) - 🔍 [Parser](#m3u8_parser-settings) - 📝 [Command](#command) - 🔍 [Global search](#global-search) - đŸ’ģ [Examples of terminal](#examples-of-terminal-usage)
🔧 Advanced Features - 🔧 [Manual domain configuration](#update-domains) - đŸŗ [Docker](#docker) - 📝 [Telegram Usage](#telegram-usage)
ℹī¸ Help & Support - 🎓 [Tutorial](#tutorials) - 📝 [To do](#to-do) - ⚠ī¸ [Disclaimer](#disclaimer)
# Installation

Windows macOS Linux Linux Previous All Versions

## 1. PyPI Installation Install directly from PyPI: ```bash pip install StreamingCommunity ``` Update to the latest version: ```bash pip install --upgrade StreamingCommunity ``` ## Quick Start Create a simple script (`run_streaming.py`) to launch the main application: ```python from StreamingCommunity.run import main if __name__ == "__main__": main() ``` Run the script: ```bash python run_streaming.py ``` ## Modules
đŸ“Ĩ HLS Downloader Download HTTP Live Streaming (HLS) content from m3u8 URLs. ```python from StreamingCommunity.Download import HLS_Downloader # Initialize with m3u8 URL and optional output path downloader = HLS_Downloader( m3u8_url="https://example.com/stream.m3u8", output_path="/downloads/video.mp4" # Optional ) # Start the download downloader.download() ``` See [HLS example](./Test/Download/HLS.py) for complete usage.
đŸ“Ŋī¸ MP4 Downloader Direct MP4 file downloader with support for custom headers and referrer. ```python from StreamingCommunity.Download import MP4_downloader # Basic usage downloader = MP4_downloader( url="https://example.com/video.mp4", path="/downloads/saved_video.mp4" ) # Advanced usage with custom headers and referrer headers = { "User-Agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36" } downloader = MP4_downloader( url="https://example.com/video.mp4", path="/downloads/saved_video.mp4", referer="https://example.com", headers_=headers ) # Start download downloader.download() ``` See [MP4 example](./Test/Download/MP4.py) for complete usage.
🧲 Torrent Client Download content via torrent magnet links. ```python from StreamingCommunity.Download import TOR_downloader # Initialize torrent client client = TOR_downloader() # Add magnet link client.add_magnet_link("magnet:?xt=urn:btih:example_hash&dn=example_name", save_path=".") # Start download client.start_download() ``` See [Torrent example](./Test/Download/TOR.py) for complete usage.
## Binary Location
📂 Default Locations - **Windows**: `C:\binary` - **MacOS**: `~/Applications/binary` - **Linux**: `~/.local/bin/binary`
đŸĒŸ Windows Configuration 1. Move the binary folder from `C:\binary` to your desired location 2. Add the new path to Windows environment variables: - Open Start menu and search for "Environment Variables" - Click "Edit the system environment variables" - Click "Environment Variables" button - Under "System Variables", find and select "Path" - Click "Edit" - Add the new binary folder path - Click "OK" to save changes For detailed Windows PATH instructions, see the [Windows PATH guide](https://www.eukhost.com/kb/how-to-add-to-the-path-on-windows-10-and-windows-11/).
🍎 MacOS Configuration 1. Move the binary folder from `~/Applications/binary` to your desired location 2. Add the new path to your shell's configuration file: ```bash # For bash (edit ~/.bash_profile) export PATH="/your/custom/path:$PATH" # For zsh (edit ~/.zshrc) export PATH="/your/custom/path:$PATH" ``` 3. Reload your shell configuration: ```bash # For bash source ~/.bash_profile # For zsh source ~/.zshrc ```
🐧 Linux Configuration 1. Move the binary folder from `~/.local/bin/binary` to your desired location 2. Add the new path to your shell's configuration file: ```bash # For bash (edit ~/.bashrc) export PATH="/your/custom/path:$PATH" # For zsh (edit ~/.zshrc) export PATH="/your/custom/path:$PATH" ``` 3. Apply the changes: ```bash source ~/.bashrc # for bash # or source ~/.zshrc # for zsh ```
> [!IMPORTANT] > After moving the binary folder, ensure that all executables (ffmpeg, ffprobe, ffplay) are present in the new location and have the correct permissions: > - Windows: `.exe` extensions required > - MacOS/Linux: Ensure files have execute permissions (`chmod +x filename`) ## 3. Manual Installation
📋 Requirements Prerequisites: * [Python](https://www.python.org/downloads/) > 3.8 * [FFmpeg](https://www.gyan.dev/ffmpeg/builds/)
⚙ī¸ 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 ```
## Update Domains
🌐 Domain Configuration Methods There are two ways to update the domains for the supported websites: ### 1. Using Local Configuration 1. Create a `domains.json` file in the root directory of the project 2. Add your domain configuration in the following format: ```json { "altadefinizione": { "domain": "si", "full_url": "https://altadefinizione.si/" }, ... } ``` 3. Set `use_api` to `false` in the `DEFAULT` section of your `config.json`: ```json { "DEFAULT": { "use_api": false } } ``` ### 2. Using API (Legacy) The API-based domain updates are currently deprecated. To use it anyway, set `use_api` to `true` in your `config.json` file. Note: If `use_api` is set to `false` and no `domains.json` file is found, the script will raise an error. #### 💡 Adding a New Site to the Legacy API If you want to add a new site to the legacy API, just message me on the Discord server, and I'll add it!
# Configuration
⚙ī¸ Overview You can change some behaviors by tweaking the configuration file. The configuration file is divided into several main sections.
🔧 DEFAULT Settings ```json { "DEFAULT": { "debug": false, "show_message": true, "clean_console": true, "show_trending": true, "use_api": true, "not_close": false, "telegram_bot": false, "download_site_data": false, "validate_github_config": false } } ``` - `debug`: Enables debug logging - `show_message`: Displays informational messages - `clean_console`: Clears the console between operations - `show_trending`: Shows trending content - `use_api`: Uses API for domain updates instead of local configuration - `not_close`: If set to true, keeps the program running after download is complete * Can be changed from terminal with `--not_close true/false` - `telegram_bot`: Enables Telegram bot integration - `download_site_data`: If set to false, disables automatic site data download - `validate_github_config`: If set to false, disables validation and updating of configuration from GitHub
📁 OUT_FOLDER Settings ```json { "OUT_FOLDER": { "root_path": "Video", "movie_folder_name": "Movie", "serie_folder_name": "Serie", "anime_folder_name": "Anime", "map_episode_name": "E%(episode)_%(episode_name)", "add_siteName": false } } ``` #### Directory Configuration - `root_path`: Directory where all videos will be saved * Windows: `C:\\MyLibrary\\Folder` or `\\\\MyServer\\MyLibrary` (network folder) * Linux/MacOS: `Desktop/MyLibrary/Folder` #### Folder Names - `movie_folder_name`: Subdirectory for movies (can be changed with `--movie_folder_name`) - `serie_folder_name`: Subdirectory for TV series (can be changed with `--serie_folder_name`) - `anime_folder_name`: Subdirectory for anime (can be changed with `--anime_folder_name`) #### Episode Naming - `map_episode_name`: Template for episode filenames * `%(tv_name)`: Name of TV Show * `%(season)`: Season number * `%(episode)`: Episode number * `%(episode_name)`: Episode name * Can be changed with `--map_episode_name` #### Additional Options - `add_siteName`: Appends site_name to root path (can be changed with `--add_siteName true/false`)
🔄 QBIT_CONFIG Settings ```json { "QBIT_CONFIG": { "host": "192.168.1.51", "port": "6666", "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).
📡 REQUESTS Settings ```json { "REQUESTS": { "verify": false, "timeout": 20, "max_retry": 8, "proxy": { "http": "http://username:password@host:port", "https": "https://username:password@host:port" } } } ``` - `verify`: Verifies SSL certificates - `timeout`: Maximum timeout (in seconds) for each request - `max_retry`: Number of retry attempts per segment during M3U8 index download - `proxy`: Proxy configuration for HTTP/HTTPS requests * Set to empty string `""` to disable proxies (default) * Example with authentication: ```json "proxy": { "http": "http://username:password@host:port", "https": "https://username:password@host:port" } ``` * Example without authentication: ```json "proxy": { "http": "http://host:port", "https": "https://host:port" } ```
đŸ“Ĩ M3U8_DOWNLOAD Settings ```json { "M3U8_DOWNLOAD": { "tqdm_delay": 0.01, "default_video_workser": 12, "default_audio_workser": 12, "segment_timeout": 8, "download_audio": true, "merge_audio": true, "specific_list_audio": [ "ita" ], "download_subtitle": true, "merge_subs": true, "specific_list_subtitles": [ "ita", "eng" ], "cleanup_tmp_folder": true } } ``` #### Performance Settings - `tqdm_delay`: Delay between progress bar updates - `default_video_workser`: Number of threads for video download * Can be changed with `--default_video_worker ` - `default_audio_workser`: Number of threads for audio download * Can be changed with `--default_audio_worker ` - `segment_timeout`: Timeout for downloading individual segments #### Audio Settings - `download_audio`: Whether to download audio tracks - `merge_audio`: Whether to merge audio with video - `specific_list_audio`: List of audio languages to download * Can be changed with `--specific_list_audio ita,eng` #### Subtitle Settings - `download_subtitle`: Whether to download subtitles - `merge_subs`: Whether to merge subtitles with video - `specific_list_subtitles`: List of subtitle languages to download * Can be changed with `--specific_list_subtitles ita,eng` #### Cleanup - `cleanup_tmp_folder`: Remove temporary .ts files after download
🌍 Available Language Codes | European | Asian | Middle Eastern | Others | |-----------------|-----------------|-----------------|-----------------| | ita - Italian | chi - Chinese | ara - Arabic | eng - English | | spa - Spanish | jpn - Japanese | heb - Hebrew | por - Portuguese| | fre - French | kor - Korean | tur - Turkish | fil - Filipino | | ger - German | hin - Hindi | | ind - Indonesian| | rus - Russian | mal - Malayalam | | may - Malay | | swe - Swedish | tam - Tamil | | vie - Vietnamese| | pol - Polish | tel - Telugu | | | | ukr - Ukrainian | tha - Thai | | |
đŸŽĨ M3U8_CONVERSION Settings ```json { "M3U8_CONVERSION": { "use_codec": false, "use_vcodec": true, "use_acodec": true, "use_bitrate": true, "use_gpu": false, "default_preset": "ultrafast" } } ``` #### Basic Settings - `use_codec`: Use specific codec settings - `use_vcodec`: Use specific video codec - `use_acodec`: Use specific audio codec - `use_bitrate`: Apply bitrate settings - `use_gpu`: Enable GPU acceleration (if available) - `default_preset`: FFmpeg encoding preset #### Encoding Presets The `default_preset` configuration can be set to: - `ultrafast`: Extremely fast conversion but larger file size - `superfast`: Very fast with good quality/size ratio - `veryfast`: Fast with good compression - `faster`: Optimal balance for most users - `fast`: Good compression, moderate time - `medium`: FFmpeg default setting - `slow`: High quality, slower process - `slower`: Very high quality, slow process - `veryslow`: Maximum quality, very slow process #### GPU Acceleration When `use_gpu` is enabled, supports: - NVIDIA: NVENC - AMD: AMF - Intel: QSV Note: Requires updated drivers and FFmpeg with hardware acceleration support.
🔍 M3U8_PARSER Settings ```json { "M3U8_PARSER": { "force_resolution": "Best", "get_only_link": false } } ``` #### Resolution Options - `force_resolution`: Choose video resolution: * `"Best"`: Highest available resolution * `"Worst"`: Lowest available resolution * `"720p"`: Force 720p resolution * Specific resolutions: - 1080p (1920x1080) - 720p (1280x720) - 480p (640x480) - 360p (640x360) - 320p (480x320) - 240p (426x240) - 240p (320x240) - 144p (256x144) #### Link Options - `get_only_link`: Return M3U8 playlist/index URL instead of downloading
# Global Search
🔍 Feature Overview You can now search across multiple streaming sites at once using the Global Search feature. This allows you to find content more efficiently without having to search each site individually.
đŸŽ¯ Search Options When using Global Search, you have three ways to select which sites to search: 1. **Search all sites** - Searches across all available streaming sites 2. **Search by category** - Group sites by their categories (movies, series, anime, etc.) 3. **Select specific sites** - Choose individual sites to include in your search
📝 Navigation and Selection After performing a search: 1. Results are displayed in a consolidated table showing: - Title - Media type (movie, TV series, etc.) - Source site 2. Select an item by number to view details or download 3. The system will automatically use the appropriate site's API to handle the download
⌨ī¸ Command Line Arguments The Global Search can be configured from the command line: - `--global` - Perform a global search across multiple sites. - `-s`, `--search` - Specify the search terms.
# Examples of terminal usage ```bash # Change video and audio workers python test_run.py --default_video_worker 8 --default_audio_worker 8 # Set specific languages python test_run.py --specific_list_audio ita,eng --specific_list_subtitles eng,spa # Keep console open after download python test_run.py --not_close true # Use global search python test_run.py --global -s "cars" ``` # Docker
đŸŗ Basic Setup Build the image: ``` docker build -t streaming-community-api . ``` Run the container with Cloudflare DNS for better connectivity: ``` docker run -it --dns 1.1.1.1 -p 8000:8000 streaming-community-api ```
💾 Custom Storage Location By default the videos will be saved in `/app/Video` inside the container. To save them on your machine: ``` docker run -it --dns 9.9.9.9 -p 8000:8000 -v /path/to/download:/app/Video streaming-community-api ```
🛠ī¸ 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.
# Telegram Usage
⚙ī¸ Basic Configuration The bot was created to replace terminal commands and allow interaction via Telegram. Each download runs within a screen session, enabling multiple downloads to run simultaneously. To run the bot in the background, simply start it inside a screen session and then press Ctrl + A, followed by D, to detach from the session without stopping the bot. Command Functions: 🔹 /start – Starts a new search for a download. This command performs the same operations as manually running the script in the terminal with test_run.py. 🔹 /list – Displays the status of active downloads, with options to: Stop an incorrect download using /stop . View the real-time output of a download using /screen . ⚠ Warning: If a download is interrupted, incomplete files may remain in the folder specified in config.json. These files must be deleted manually to avoid storage or management issues. 🛠 Configuration: Currently, the bot's settings are stored in the config.json file, which is located in the same directory as the telegram_bot.py script. ## .env Example: You need to create an .env file and enter your Telegram token and user ID to authorize only one user to use it ``` TOKEN_TELEGRAM=IlTuo2131TOKEN$12D3Telegram AUTHORIZED_USER_ID=12345678 DEBUG=False ```
đŸ“Ĩ Dependencies & Launch Install dependencies: ```bash pip install -r requirements.txt ``` Start the bot (from /StreamingCommunity/TelegramHelp): ```bash python3 telegram_bot.py ```
# 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 - To Finish [website API](https://github.com/Arrowar/StreamingCommunity/tree/test_gui_1) - To finish [website API 2](https://github.com/hydrosh/StreamingCommunity/tree/test_gui_1) ## Useful Project ### đŸŽ¯ [Unit3Dup](https://github.com/31December99/Unit3Dup) Bot in Python per la generazione e l'upload automatico di torrent su tracker basati su Unit3D. ### 🇮🇹 [MammaMia](https://github.com/UrloMythus/MammaMia) Addon per Stremio che consente lo streaming HTTPS di film, serie, anime e TV in diretta in lingua italiana. ### 🧩 [streamingcommunity-unofficialapi](https://github.com/Blu-Tiger/streamingcommunity-unofficialapi) API non ufficiale per accedere ai contenuti del sito italiano StreamingCommunity. ### đŸŽĨ [stream-buddy](https://github.com/Bbalduzz/stream-buddy) Tool per guardare o scaricare film dalla piattaforma StreamingCommunity. # 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.