eaf-base-api 1.6.3__tar.gz → 2.1__tar.gz

eaf_base_api-2.1/LICENSE

@@ -0,0 +1,56 @@
+GNU LESSER GENERAL PUBLIC LICENSE
+Version 3, 29 June 2007
+
+Copyright © 2007 Free Software Foundation, Inc. <https://fsf.org/>
+
+Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
+
+This version of the GNU Lesser General Public License incorporates the terms and conditions of version 3 of the GNU General Public License, supplemented by the additional permissions listed below.
+
+0. Additional Definitions.
+As used herein, “this License” refers to version 3 of the GNU Lesser General Public License, and the “GNU GPL” refers to version 3 of the GNU General Public License.
+
+“The Library” refers to a covered work governed by this License, other than an Application or a Combined Work as defined below.
+
+An “Application” is any work that makes use of an interface provided by the Library, but which is not otherwise based on the Library. Defining a subclass of a class defined by the Library is deemed a mode of using an interface provided by the Library.
+
+A “Combined Work” is a work produced by combining or linking an Application with the Library. The particular version of the Library with which the Combined Work was made is also called the “Linked Version”.
+
+The “Minimal Corresponding Source” for a Combined Work means the Corresponding Source for the Combined Work, excluding any source code for portions of the Combined Work that, considered in isolation, are based on the Application, and not on the Linked Version.
+
+The “Corresponding Application Code” for a Combined Work means the object code and/or source code for the Application, including any data and utility programs needed for reproducing the Combined Work from the Application, but excluding the System Libraries of the Combined Work.
+
+1. Exception to Section 3 of the GNU GPL.
+You may convey a covered work under sections 3 and 4 of this License without being bound by section 3 of the GNU GPL.
+
+2. Conveying Modified Versions.
+If you modify a copy of the Library, and, in your modifications, a facility refers to a function or data to be supplied by an Application that uses the facility (other than as an argument passed when the facility is invoked), then you may convey a copy of the modified version:
+
+a) under this License, provided that you make a good faith effort to ensure that, in the event an Application does not supply the function or data, the facility still operates, and performs whatever part of its purpose remains meaningful, or
+b) under the GNU GPL, with none of the additional permissions of this License applicable to that copy.
+3. Object Code Incorporating Material from Library Header Files.
+The object code form of an Application may incorporate material from a header file that is part of the Library. You may convey such object code under terms of your choice, provided that, if the incorporated material is not limited to numerical parameters, data structure layouts and accessors, or small macros, inline functions and templates (ten or fewer lines in length), you do both of the following:
+
+a) Give prominent notice with each copy of the object code that the Library is used in it and that the Library and its use are covered by this License.
+b) Accompany the object code with a copy of the GNU GPL and this license document.
+4. Combined Works.
+You may convey a Combined Work under terms of your choice that, taken together, effectively do not restrict modification of the portions of the Library contained in the Combined Work and reverse engineering for debugging such modifications, if you also do each of the following:
+
+a) Give prominent notice with each copy of the Combined Work that the Library is used in it and that the Library and its use are covered by this License.
+b) Accompany the Combined Work with a copy of the GNU GPL and this license document.
+c) For a Combined Work that displays copyright notices during execution, include the copyright notice for the Library among these notices, as well as a reference directing the user to the copies of the GNU GPL and this license document.
+d) Do one of the following:
+0) Convey the Minimal Corresponding Source under the terms of this License, and the Corresponding Application Code in a form suitable for, and under terms that permit, the user to recombine or relink the Application with a modified version of the Linked Version to produce a modified Combined Work, in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.
+1) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (a) uses at run time a copy of the Library already present on the user's computer system, and (b) will operate properly with a modified version of the Library that is interface-compatible with the Linked Version.
+e) Provide Installation Information, but only if you would otherwise be required to provide such information under section 6 of the GNU GPL, and only to the extent that such information is necessary to install and execute a modified version of the Combined Work produced by recombining or relinking the Application with a modified version of the Linked Version. (If you use option 4d0, the Installation Information must accompany the Minimal Corresponding Source and Corresponding Application Code. If you use option 4d1, you must provide the Installation Information in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.)
+5. Combined Libraries.
+You may place library facilities that are a work based on the Library side by side in a single library together with other library facilities that are not Applications and are not covered by this License, and convey such a combined library under terms of your choice, if you do both of the following:
+
+a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities, conveyed under the terms of this License.
+b) Give prominent notice with the combined library that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work.
+6. Revised Versions of the GNU Lesser General Public License.
+The Free Software Foundation may publish revised and/or new versions of the GNU Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Library as you received it specifies that a certain numbered version of the GNU Lesser General Public License “or any later version” applies to it, you have the option of following the terms and conditions either of that published version or of any later version published by the Free Software Foundation. If the Library as you received it does not specify a version number of the GNU Lesser General Public License, you may choose any version of the GNU Lesser General Public License ever published by the Free Software Foundation.
+
+If the Library as you received it specifies that a proxy can decide whether future versions of the GNU Lesser General Public License shall apply, that proxy's public statement of acceptance of any version is permanent authorization for you to choose that version for the Library.

eaf_base_api-2.1/PKG-INFO

@@ -0,0 +1,43 @@
+Metadata-Version: 2.1
+Name: eaf_base_api
+Version: 2.1
+Summary: A base API for EchterAlsFake's Porn APIs
+Home-page: https://github.com/EchterAlsFake/eaf_base_api
+Author: Johannes Habel
+Author-email: EchterAlsFake@proton.me
+License: LGPLv3
+Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
+Classifier: Programming Language :: Python
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: ffmpeg-progress-yield
+Requires-Dist: m3u8
+Requires-Dist: httpx
+
+# EAF Base API
+
+# What is this?
+When using one of my Porn site APIs, you probably came across this package and wondered what it actually does, so here's
+a detailed answer. 
+
+A lot of Porn sites use very similar methods for m3u8 (HLS) parsing and other things. I also wanted to implement proxy
+support, and there was a lot of code that I would have rewritten in every API again and again. That's why I made this API
+package. The `BaseCore` class does all the necessary stuff like m3u8 parsing, a great caching system, network request
+fetching with retry attempts and proxy support.
+
+# Using Proxies / Caching
+There's a small documentation for this project.
+<br>Please have a look at it: https://github.com/EchterAlsFake/API_Docs/blob/master/Porn_APIs/eaf_base_api.md
+
+
+# Can I use this for myself?
+Yes, you can, but I may change stuff here and there from time to time, and it would maybe break your project.
+I would not recommend you to install and use it as a package, but just copy the code you need.
+
+I can recommend everyone the download functions for HLS streaming since, for example, the threaded preset is very well 
+optimized. If you just use mine, you need to consume less caffeine and brain cells to make such a function :)
+
+
+# License
+Licensed under The [LGPLv3](https://www.gnu.org/licenses/lgpl-3.0.en.html) license.
+<br>Copyright (C) 2024-2025 Johannes Habel

eaf_base_api-2.1/README.md

@@ -0,0 +1,27 @@
+# EAF Base API
+
+# What is this?
+When using one of my Porn site APIs, you probably came across this package and wondered what it actually does, so here's
+a detailed answer. 
+
+A lot of Porn sites use very similar methods for m3u8 (HLS) parsing and other things. I also wanted to implement proxy
+support, and there was a lot of code that I would have rewritten in every API again and again. That's why I made this API
+package. The `BaseCore` class does all the necessary stuff like m3u8 parsing, a great caching system, network request
+fetching with retry attempts and proxy support.
+
+# Using Proxies / Caching
+There's a small documentation for this project.
+<br>Please have a look at it: https://github.com/EchterAlsFake/API_Docs/blob/master/Porn_APIs/eaf_base_api.md
+
+
+# Can I use this for myself?
+Yes, you can, but I may change stuff here and there from time to time, and it would maybe break your project.
+I would not recommend you to install and use it as a package, but just copy the code you need.
+
+I can recommend everyone the download functions for HLS streaming since, for example, the threaded preset is very well 
+optimized. If you just use mine, you need to consume less caffeine and brain cells to make such a function :)
+
+
+# License
+Licensed under The [LGPLv3](https://www.gnu.org/licenses/lgpl-3.0.en.html) license.
+<br>Copyright (C) 2024-2025 Johannes Habel

eaf_base_api-2.1/base_api/__init__.py

@@ -0,0 +1,4 @@
+__all__ = ["BaseCore", "Callback"]
+
+from base_api.base import BaseCore
+from base_api.modules.progress_bars import Callback

eaf_base_api-2.1/base_api/base.py

@@ -0,0 +1,418 @@
+import os
+import time
+import m3u8
+import httpx
+import random
+import string
+import logging
+import traceback
+import threading
+
+from typing import Union
+from functools import lru_cache
+from urllib.parse import urljoin
+from ffmpeg_progress_yield import FfmpegProgress
+from concurrent.futures import ThreadPoolExecutor, as_completed
+
+try:
+    from modules import consts
+    from modules.progress_bars import Callback
+
+except (ModuleNotFoundError, ImportError):
+    from .modules import consts
+    from .modules.progress_bars import Callback
+
+logging.basicConfig(format='%(name)s %(levelname)s %(asctime)s %(message)s', datefmt='%I:%M:%S %p')
+logger = logging.getLogger("BASE API")
+logger.setLevel(logging.DEBUG)
+
+def disable_logging():
+    logger.setLevel(logging.CRITICAL)
+
+
+class Cache:
+    """
+    Caches content from network requests
+    """
+
+    def __init__(self):
+        self.cache_dictionary = {}
+        self.lock = threading.Lock()
+
+    def handle_cache(self, url):
+        if url is None:
+            return
+
+        with self.lock:
+            content = self.cache_dictionary.get(url, None)
+            return content
+
+    def save_cache(self, url, content):
+        with self.lock:
+            if len(self.cache_dictionary.keys()) >= consts.MAX_CACHE_ITEMS:
+                first_key = next(iter(self.cache_dictionary))
+                # Delete the first item
+                del self.cache_dictionary[first_key]
+                logger.info(f"Deleting: {first_key} from cache, due to caching limits...")
+
+            self.cache_dictionary[url] = content
+
+cache = Cache()
+
+
+class BaseCore:
+    """
+    The base class which has all necessary functions for other API packages
+    """
+    def __init__(self):
+        self.last_request_time = time.time()
+        self.total_requests = 0 # Tracks how many requests have been made
+        self.session = None
+        self.initialize_session()
+
+
+    def update_user_agent(self):
+        """Updates the User-Agent"""
+        self.session.headers.update({"User-Agent": random.choice(consts.USER_AGENTS)})
+
+    def initialize_session(self):
+        verify = True
+
+        if consts.PROXY is not None:
+            verify = False
+
+        self.session = httpx.Client(proxy=consts.PROXY,
+                              headers=consts.HEADERS,
+                              verify=verify,
+                              timeout=consts.TIMEOUT
+                              )
+
+    def enforce_delay(self):
+        """Enforces the specified delay in consts.REQUEST_DELAY"""
+        delay = consts.REQUEST_DELAY
+        if delay > 0:
+            time_since_last_request = time.time() - self.last_request_time
+            logger.debug(f"Time since last request: {time_since_last_request:.2f} seconds.")
+            if time_since_last_request < delay:
+                sleep_time = delay - time_since_last_request
+                logger.debug(f"Enforcing delay of {sleep_time:.2f} seconds.")
+                time.sleep(sleep_time)
+
+    def fetch(
+            self,
+            url: str,
+            get_bytes: bool = False,
+            timeout: int = consts.TIMEOUT,
+            get_response: bool = False,
+            save_cache: bool = True,
+            cookies: dict = None,
+            allow_redirects: bool = True,
+    ) -> Union[bytes, str, httpx.Response, None]:
+        """
+        Fetches content in UTF-8 Text, Bytes, or as a stream using multiple request attempts,
+        support for proxies and custom timeout.
+        """
+        # Check cache first
+        content = cache.handle_cache(url)
+        if content is not None:
+            logger.info(f"Fetched content for: {url} from cache!")
+            return content
+
+        for attempt in range(1, consts.MAX_RETRIES + 1):
+            try:
+                # Update user agent periodically
+                if self.total_requests % 3 == 0:
+                    self.update_user_agent()
+
+                self.enforce_delay()
+
+                # Perform the request with stream handling
+                with self.session.stream("GET", url, timeout=timeout, cookies=cookies,
+                                         follow_redirects=allow_redirects) as response:
+                    self.total_requests += 1
+
+                    # Log and handle non-200 status codes
+                    if response.status_code != 200:
+                        logger.warning(
+                            f"Attempt {attempt}: Unexpected status code {response.status_code} for URL: {url}")
+
+                        if response.status_code == 404:
+                            logger.error("Resource not found (404). This may indicate the content is unavailable.")
+                            return None  # Return None for unavailable resources
+
+                        continue  # Retry for other non-200 status codes
+
+                    logger.debug(f"Attempt {attempt}: Successfully fetched URL: {url}")
+
+                    # Return response if requested
+                    if get_response:
+                        return response
+
+                    # Process and return content
+                    if get_bytes:
+                        content = b"".join([chunk for chunk in response.iter_bytes()])
+                    else:
+                        content = "".join([chunk.decode("utf-8") for chunk in response.iter_bytes()])
+                        if save_cache:
+                            logger.debug(f"Saving content of {url} to local cache.")
+                            cache.save_cache(url, content)
+
+                    return content
+
+            except httpx.RequestError as e:
+                logger.error(f"Attempt {attempt}: Request error for URL {url}: {e}")
+
+            except Exception:
+                logger.error(f"Attempt {attempt}: Unexpected error for URL {url}: {traceback.format_exc()}")
+
+            logger.info(f"Retrying ({attempt}/{consts.MAX_RETRIES}) for URL: {url}")
+
+        logger.error(f"Failed to fetch URL {url} after {consts.MAX_RETRIES} attempts.")
+        return None  # Return None if all attempts fail
+
+    @classmethod
+    def strip_title(cls, title: str) -> str:
+        """
+        :param title:
+        :return: str: strips out non UTF-8 chars of the title
+        """
+        illegal_chars = '<>:"/\\|?*'
+        cleaned_title = ''.join([char for char in title if char in string.printable and char not in illegal_chars])
+        return cleaned_title
+
+    @lru_cache(maxsize=250)
+    def get_m3u8_by_quality(self, m3u8_url: str, quality: str) -> str:
+        """Fetches the m3u8 URL for a given quality by extracting all possible sub-m3u8 URLs from the primary
+        m3u8 playlist"""
+        playlist_content = self.fetch(url=m3u8_url)
+        playlist = m3u8.loads(playlist_content)
+        logger.debug(f"Resolved m3u8 playlist: {m3u8_url}")
+
+        if not playlist.is_variant:
+            raise ValueError("Provided URL is not a master playlist.")
+
+        # Extract available qualities and URLs
+        qualities = {
+            (variant.stream_info.resolution or "unknown"): variant.uri
+            for variant in playlist.playlists
+        } # Fetches the available qualities
+
+        # Sort qualities by resolution (width x height)
+        sorted_qualities = sorted(
+            qualities.items(),
+            key=lambda x: (x[0][0] * x[0][1]) if x[0] != "unknown" else 0
+        ) # Sorts qualities to support different HLS naming schemes
+
+        # Select based on quality preference
+        if quality == "best":
+            url_tmp = sorted_qualities[-1][1]  # Highest resolution URL
+
+        elif quality == "worst":
+            url_tmp = sorted_qualities[0][1]  # Lowest resolution URL
+
+        elif quality == "half":
+            url_tmp = sorted_qualities[len(sorted_qualities) // 2][1]  # Mid-quality URL
+
+        else:
+            raise ValueError("Invalid quality provided.")
+
+        full_url = urljoin(m3u8_url, url_tmp) # Merges the primary with the new URL to get the full URL path
+        return full_url
+
+    @lru_cache(maxsize=250)
+    def get_segments(self, m3u8_url_master: str, quality: str) -> list:
+        """Gets all video segments from a given quality and the primary m3u8 URL"""
+        m3u8_url = self.get_m3u8_by_quality(m3u8_url=m3u8_url_master, quality=quality)
+        logger.debug(f"Trying to fetch segment from m3u8 ->: {m3u8_url}")
+        content = self.fetch(url=m3u8_url)
+        segments_ = m3u8.loads(content).segments
+        segments = []
+
+        for segment in segments_:
+            segments.append(urljoin(m3u8_url, segment.uri)) # Get the full URL path to segment
+
+        logger.debug(f"Fetched {len(segments)} segments from m3u8 URL")
+        return segments
+
+    def download(self, video, quality: str, downloader: str, path: str, callback=None) -> None:
+        """
+        :param video:
+        :param callback:
+        :param downloader:
+        :param quality:
+        :param path:
+        :return:
+        """
+
+        if callback is None:
+            callback = Callback.text_progress_bar
+
+        if downloader == "default":
+            self.default(video=video, quality=quality, path=path, callback=callback)
+
+        elif downloader == "threaded":
+            threaded_download = self.threaded(max_workers=20, timeout=10)
+            threaded_download(self, video=video, quality=quality, path=path, callback=callback)
+
+        elif downloader == "FFMPEG":
+            self.FFMPEG(video=video, quality=quality, path=path, callback=callback)
+
+    @classmethod
+    def download_segment(cls, url: str, timeout: int) -> tuple[str, bytes, bool]:
+        """
+        Attempt to download a single segment, retrying on failure.
+        Returns a tuple of the URL, content (empty if failed after retries), and a success flag.
+        """
+
+        response = BaseCore().fetch(url, timeout=timeout, get_response=True)
+        response.raise_for_status()
+        content = b"".join(response.iter_bytes())
+        return url, content, True  # Success
+
+    def threaded(self, max_workers: int = 20, timeout: int = 10):
+        """
+        Creates a wrapper function for the actual download process, with retry logic.
+        """
+
+        def wrapper(self, video, quality: str, callback, path: str):
+            """
+            Download video segments in parallel, with retries for failures, and write to a file.
+            """
+            segments = self.get_segments(quality=quality, m3u8_url_master=video.m3u8_base_url)
+            length = len(segments)
+            completed, successful_downloads = 0, 0
+
+            with ThreadPoolExecutor(max_workers=max_workers) as executor:
+                future_to_hls_part = {
+                    executor.submit(self.download_segment, url, timeout): os.path.basename(url)
+                    for url in segments
+                }
+
+                for future in as_completed(future_to_hls_part):
+                    hls_part = future_to_hls_part[future]
+                    try:
+                        _, data, success = future.result()
+                        completed += 1
+                        if success:
+                            successful_downloads += 1
+                        callback(completed, length)  # Update progress callback
+                    except Exception as e:
+                        logger.error(f"Error processing segment {hls_part}: {e}")
+
+            # Write only successful segments to the output file
+            with open(path, 'wb') as file:
+                for segment_url in segments:
+                    matched_futures = [
+                        future for future, hls_part in future_to_hls_part.items()
+                        if hls_part == os.path.basename(segment_url)
+                    ]
+                    if matched_futures:
+                        future = matched_futures[0]
+                        try:
+                            _, data, success = future.result()
+                            if success:
+                                file.write(data)
+                        except Exception as e:
+                            logger.error(f"Exception writing segment {segment_url}: {e}")
+
+        return wrapper
+
+    def default(self, video, quality, callback, path, start: int = 0) -> bool:
+        buffer = b''
+        segments = self.get_segments(quality=quality, m3u8_url_master=video.m3u8_base_url)[start:]
+        length = len(segments)
+
+        for i, url in enumerate(segments):
+            for _ in range(5):
+
+                segment = self.fetch(url, get_bytes=True)
+                buffer += segment
+                callback(i + 1, length)
+                break
+
+        with open(path, 'wb') as file:
+            file.write(buffer)
+
+        return True
+
+    def FFMPEG(self, video, quality: str, callback, path: str) -> bool:
+        base_url = video.m3u8_base_url
+        new_segment = self.get_m3u8_by_quality(quality=quality, m3u8_url=base_url)
+        url_components = base_url.split('/')
+        url_components[-1] = new_segment
+        new_url = '/'.join(url_components)
+
+        # Build the command for FFMPEG as a list directly
+        command = [
+            consts.FFMPEG_PATH,
+            "-i", new_url,  # Input URL
+            "-bsf:a", "aac_adtstoasc",
+            "-y",  # Overwrite output files without asking
+            "-c", "copy",  # Copy streams without re-encoding
+            path  # Output file path
+        ]
+
+        # Initialize FfmpegProgress and execute the command
+        ff = FfmpegProgress(command)
+        for progress in ff.run_command_with_progress():
+            # Update the callback with the current progress
+            callback(int(round(progress)), 100)
+
+            if progress == 100:
+                return True
+
+        return False
+
+    def legacy_download(self, path: str, url: str, callback=None) -> bool:
+        """
+        Download a file using streaming, with support for progress updates.
+        """
+        try:
+            with self.session.stream("GET", url, timeout=30) as response:  # Use a reasonable timeout
+                response.raise_for_status()
+
+                file_size = int(response.headers.get('content-length', 0))
+
+                if callback is None:
+                    progress_bar = Callback()
+
+                downloaded_so_far = 0
+
+                # Open file for writing
+                with open(path, 'wb') as file:
+                    for chunk in response.iter_bytes(chunk_size=1024):
+                        if not chunk:
+                            break  # End of stream
+
+                        file.write(chunk)
+                        downloaded_so_far += len(chunk)
+
+                        # Update progress
+                        if callback:
+                            callback(downloaded_so_far, file_size)
+                        else:
+                            progress_bar.text_progress_bar(downloaded=downloaded_so_far, total=file_size)
+
+                if not callback:
+                    del progress_bar
+
+                return True
+
+        except httpx.RequestError as e:
+            logger.error(f"Request failed for URL {url}: {e}")
+            return False
+        except Exception as e:
+            logger.error(f"Unexpected error during download: {e}")
+            return False
+
+    @classmethod
+    def return_path(cls, video, args) -> str:
+        path = args.output
+        if args.use_title:
+            if not str(path).endswith(os.sep):
+                path += os.sep
+            path += video.title + ".mp4"
+        else:
+            path = args.output
+
+        return path

eaf_base_api-2.1/base_api/modules/consts.py

@@ -0,0 +1,16 @@
+import random
+
+MAX_CACHE_ITEMS = 200 # Lower this value if you are on a low-ram system (<=4 GB)
+MAX_RETRIES = 4
+REQUEST_DELAY = 0
+TIMEOUT = 20 # Maximal request timeout
+FFMPEG_PATH = "ffmpeg"
+PROXY = None
+USER_AGENTS = ["Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/131.0.0.0 Safari/537.36",
+           "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.6 Safari/605.1.1",
+           "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/131.0.0.0 Safari/537.3",
+           "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.3",
+           "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/131.0.0.0 Safari/537.36 Edg/131.0.0."]
+
+HEADERS = {"User-Agent": random.choice(USER_AGENTS)}
+COOKIES = None

eaf_base_api-2.1/eaf_base_api.egg-info/PKG-INFO

@@ -0,0 +1,43 @@
+Metadata-Version: 2.1
+Name: eaf_base_api
+Version: 2.1
+Summary: A base API for EchterAlsFake's Porn APIs
+Home-page: https://github.com/EchterAlsFake/eaf_base_api
+Author: Johannes Habel
+Author-email: EchterAlsFake@proton.me
+License: LGPLv3
+Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
+Classifier: Programming Language :: Python
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: ffmpeg-progress-yield
+Requires-Dist: m3u8
+Requires-Dist: httpx
+
+# EAF Base API
+
+# What is this?
+When using one of my Porn site APIs, you probably came across this package and wondered what it actually does, so here's
+a detailed answer. 
+
+A lot of Porn sites use very similar methods for m3u8 (HLS) parsing and other things. I also wanted to implement proxy
+support, and there was a lot of code that I would have rewritten in every API again and again. That's why I made this API
+package. The `BaseCore` class does all the necessary stuff like m3u8 parsing, a great caching system, network request
+fetching with retry attempts and proxy support.
+
+# Using Proxies / Caching
+There's a small documentation for this project.
+<br>Please have a look at it: https://github.com/EchterAlsFake/API_Docs/blob/master/Porn_APIs/eaf_base_api.md
+
+
+# Can I use this for myself?
+Yes, you can, but I may change stuff here and there from time to time, and it would maybe break your project.
+I would not recommend you to install and use it as a package, but just copy the code you need.
+
+I can recommend everyone the download functions for HLS streaming since, for example, the threaded preset is very well 
+optimized. If you just use mine, you need to consume less caffeine and brain cells to make such a function :)
+
+
+# License
+Licensed under The [LGPLv3](https://www.gnu.org/licenses/lgpl-3.0.en.html) license.
+<br>Copyright (C) 2024-2025 Johannes Habel

{eaf_base_api-1.6.3 → eaf_base_api-2.1}/eaf_base_api.egg-info/SOURCES.txt

@@ -1,12 +1,11 @@
+LICENSE
 README.md
 setup.py
 base_api/__init__.py
 base_api/base.py
 base_api/modules/__init__.py
 base_api/modules/consts.py
-base_api/modules/download.py
 base_api/modules/progress_bars.py
-base_api/modules/quality.py
 eaf_base_api.egg-info/PKG-INFO
 eaf_base_api.egg-info/SOURCES.txt
 eaf_base_api.egg-info/dependency_links.txt

{eaf_base_api-1.6.3 → eaf_base_api-2.1}/eaf_base_api.egg-info/requires.txt

@@ -1,2 +1,3 @@
-requests
 ffmpeg-progress-yield
+m3u8
+httpx

{eaf_base_api-1.6.3 → eaf_base_api-2.1}/setup.py

@@ -2,10 +2,9 @@ from setuptools import setup, find_packages
 
 setup(
     name="eaf_base_api",
-    version="1.6.3",
+    version="2.1",
     packages=find_packages(),
-    install_requires=[
-        "requests", "ffmpeg-progress-yield"
+    install_requires=["ffmpeg-progress-yield", "m3u8", "httpx"
     ],
     entry_points={
         'console_scripts': [

eaf_base_api-1.6.3/PKG-INFO

@@ -1,44 +0,0 @@
-Metadata-Version: 2.1
-Name: eaf_base_api
-Version: 1.6.3
-Summary: A base API for EchterAlsFake's Porn APIs
-Home-page: https://github.com/EchterAlsFake/eaf_base_api
-Author: Johannes Habel
-Author-email: EchterAlsFake@proton.me
-License: LGPLv3
-Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
-Classifier: Programming Language :: Python
-Description-Content-Type: text/markdown
-Requires-Dist: requests
-Requires-Dist: ffmpeg-progress-yield
-
-# EAF Base API
-
-! Still in Development
-
-This Python package is a base api for all my Porn Site APIs. A lot of sites use the same methods, and
-there's a lot of code that I've rewritten again and again. This is why I created this base api, so that 
-I need to write less code and everything is easier to be maintainable. 
-
-# PRs
-Pull Requests are welcome, but if you make changes run `pytest` on all APIs that are using this to make sure your
-PR didn't break anything.
-
-# Documentation
-
-As this is some kind of 'raw' base API, this won't be documented, as it's only functional when used together
-with the main APIs. 
-
-Maybe you can look at the code comments. They could be helpful
-
-# Implementation
-You are welcome to implement this API in your own projects. If it's useful... But I don't recommend this, as things
-might change without a warning. But things like the threaded downloads can be useful for other projects :) 
-
-I'd say the threaded modes from the download module are already very well optimized, so feel free to just copy them
-for your own projects. You don't need to do any attribution, I don't care :) 
-
-
-# License
-
-LGPLv3

eaf_base_api-1.6.3/README.md

@@ -1,30 +0,0 @@
-# EAF Base API
-
-! Still in Development
-
-This Python package is a base api for all my Porn Site APIs. A lot of sites use the same methods, and
-there's a lot of code that I've rewritten again and again. This is why I created this base api, so that 
-I need to write less code and everything is easier to be maintainable. 
-
-# PRs
-Pull Requests are welcome, but if you make changes run `pytest` on all APIs that are using this to make sure your
-PR didn't break anything.
-
-# Documentation
-
-As this is some kind of 'raw' base API, this won't be documented, as it's only functional when used together
-with the main APIs. 
-
-Maybe you can look at the code comments. They could be helpful
-
-# Implementation
-You are welcome to implement this API in your own projects. If it's useful... But I don't recommend this, as things
-might change without a warning. But things like the threaded downloads can be useful for other projects :) 
-
-I'd say the threaded modes from the download module are already very well optimized, so feel free to just copy them
-for your own projects. You don't need to do any attribution, I don't care :) 
-
-
-# License
-
-LGPLv3

eaf_base_api-1.6.3/base_api/__init__.py

@@ -1,5 +0,0 @@
-__all__ = ["Core", "Quality", "setup_api", "default", "threaded", "FFMPEG", "Callback"]
-
-from base_api.base import Core, Quality, setup_api
-from base_api.modules.download import default, threaded, FFMPEG
-from base_api.modules.progress_bars import Callback

eaf_base_api-1.6.3/base_api/base.py

@@ -1,181 +0,0 @@
-import requests
-import logging
-import time
-import string
-import os
-
-from base_api.modules.quality import Quality
-from base_api.modules.progress_bars import Callback
-from base_api.modules.download import default, threaded, FFMPEG
-from base_api.modules.consts import MAX_RETRIES, REQUEST_DELAY
-
-def setup_api(do_logging=False):
-    if do_logging:
-        logging.basicConfig(level=logging.DEBUG, format='%(asctime)s - %(name)s - %(levelname)s - %(message)s')
-        logging.getLogger("urllib3").setLevel(logging.WARNING)
-
-    else:
-        logging.disable(logging.CRITICAL)
-
-
-class Core:
-    def __init__(self, delay=REQUEST_DELAY):
-        self.delay = delay
-        self.start_delay = False
-        self.last_request_time = None
-
-    def get_content(self, url, headers=None, cookies=None, stream=False):
-        for i in range(MAX_RETRIES):
-            try:
-                # Delay mechanism
-                if self.last_request_time:
-                    elapsed_time = time.time() - self.last_request_time
-                    if elapsed_time < self.delay:
-                        time.sleep(self.delay - elapsed_time)
-
-                self.last_request_time = time.time()  # Update the time of the last request
-
-                logging.debug(f"Trying to fetch {url} / Attempt: [{i+1}]")
-                response = requests.get(url, headers=headers, cookies=cookies, stream=stream)
-                if response.status_code == 200:
-                    logging.info(f"Successfully fetched {url} on attempt [{i+1}]")
-                    return response.content
-
-                else:
-                    logging.warning(f"Failed to fetch {url} with status code {response.status_code} on attempt [{i+1}]")
-
-            except requests.exceptions.RequestException as e:
-                logging.error(f"Exception occurred when trying to fetch {url} on attempt [{i+1}]: {e}")
-
-            if i < MAX_RETRIES - 1:  # Implement exponential backoff
-                time.sleep(2 ** i)
-
-        logging.error(f"Failed to fetch {url} after {MAX_RETRIES} attempts.")
-        logging.error("Returning None")
-        return None
-
-    @classmethod
-    def fix_quality(cls, quality):
-        """This method gives the user the opportunity to pass a string instead of the quality object"""
-        if isinstance(quality, Quality):
-            return quality
-
-        elif str(quality) == "best":
-            return Quality.BEST
-
-        elif str(quality) == "half":
-            return Quality.HALF
-
-        elif str(quality) == "worst":
-            return Quality.WORST
-
-    def get_available_qualities(self, m3u8_base_url, base_qualities, seperator):
-        """Returns the available qualities from the M3U8 base url"""
-        content = self.get_content(m3u8_base_url).decode("utf-8")
-        lines = content.splitlines()
-
-        quality_url_map = {}
-
-        for line in lines:
-            for quality in base_qualities:
-                if f"{seperator}{quality}" in line and not str(line).startswith("#"):
-                    quality_url_map[quality] = line
-
-        self.quality_url_map = quality_url_map
-        self.available_qualities = list(quality_url_map.keys())
-        return self.available_qualities
-
-    def get_m3u8_by_quality(self, quality, m3u8_base_url, base_qualities, seperator):
-        """Returns the m3u8 url for the given quality"""
-        quality = self.fix_quality(quality)
-
-        self.get_available_qualities(m3u8_base_url, base_qualities, seperator=seperator)
-        if quality == Quality.BEST:
-            selected_quality = max(self.available_qualities, key=lambda q: base_qualities.index(q))
-        elif quality == Quality.WORST:
-            selected_quality = min(self.available_qualities, key=lambda q: base_qualities.index(q))
-        elif quality == Quality.HALF:
-            sorted_qualities = sorted(self.available_qualities, key=lambda q: base_qualities.index(q))
-            middle_index = len(sorted_qualities) // 2
-            selected_quality = sorted_qualities[middle_index]
-
-        return self.quality_url_map.get(selected_quality)
-
-    def download(self, video, quality, downloader, path, callback=None):
-        """
-        :param callback:
-        :param downloader:
-        :param quality:
-        :param path:
-        :return:
-        """
-        quality = self.fix_quality(quality)
-
-        if callback is None:
-            callback = Callback.text_progress_bar
-
-        if downloader == default or str(downloader) == "default":
-            default(video=video, quality=quality, path=path, callback=callback)
-
-        elif downloader == threaded or str(downloader) == "threaded":
-            threaded_download = threaded(max_workers=20, timeout=10)
-            threaded_download(video=video, quality=quality, path=path, callback=callback)
-
-        elif downloader == FFMPEG or str(downloader) == "FFMPEG":
-            FFMPEG(video=video, quality=quality, path=path, callback=callback)
-
-    @classmethod
-    def get_segments(cls, quality, m3u8_base_url, base_qualities, seperator, source=1):
-        quality = Core().fix_quality(quality)
-        base_url = m3u8_base_url
-        new_segment = Core().get_m3u8_by_quality(quality, m3u8_base_url=base_url, base_qualities=base_qualities,
-                                                 seperator=seperator)
-        # Split the base URL into components
-        url_components = base_url.split('/')
-
-        # Replace the last component with the new segment
-        url_components[-1] = new_segment
-
-        # Rejoin the components into the new full URL
-        new_url = '/'.join(url_components)
-
-        if source == "spankbang":
-            new_url = new_url.split(".mp4.urlset/")[1]  # Please just don't ask, I'm a terrible programmer fr
-
-        master_src = Core().get_content(url=new_url).decode("utf-8")
-
-        urls = [l for l in master_src.splitlines()
-                if l and not l.startswith('#')]
-
-        segments = []
-
-        for url in urls:
-            url_components[-1] = url
-            new_url = '/'.join(url_components)
-            segments.append(new_url)
-
-        return segments
-
-    @classmethod
-    def strip_title(cls, title: str) -> str:
-        """
-        :param title:
-        :return: str: strips out non UTF-8 chars of the title
-        """
-        illegal_chars = '<>:"/\\|?*'
-        cleaned_title = ''.join([char for char in title if char in string.printable and char not in illegal_chars])
-        return cleaned_title
-
-    @classmethod
-    def return_path(cls, video, args):
-        path = args.output
-        if args.use_title:
-            if not str(path).endswith(os.sep):
-                path += os.sep
-
-            path += video.title + ".mp4"
-
-        else:
-            path = args.output
-
-        return path

eaf_base_api-1.6.3/base_api/modules/consts.py

@@ -1,3 +0,0 @@
-MAX_RETRIES = 4
-REQUEST_DELAY = 0
-FFMPEG_PATH = "ffmpeg"

eaf_base_api-1.6.3/base_api/modules/download.py

@@ -1,166 +0,0 @@
-# Thanks to: https://github.com/EchterAlsFake/PHUB/blob/master/src/phub/modules/download.py
-# oh and of course ChatGPT lol
-import logging
-import time
-import requests
-import os
-from ffmpeg_progress_yield import FfmpegProgress
-from concurrent.futures import ThreadPoolExecutor, as_completed
-from typing import Callable, List
-from base_api.modules.progress_bars import Callback
-
-try:
-    from base_api.modules.consts import FFMPEG_PATH
-
-except (ModuleNotFoundError, ImportError):
-    from .consts import FFMPEG_PATH
-
-CallbackType = Callable[[int, int], None]
-
-"""
-Important: The title of the video isn't applied to the output path. You need to manually append it to 
-the output path. This has good reasons, to make this library more adaptable into other applications.
-"""
-
-
-def download_segment(url: str, timeout: int, retries: int = 3, backoff_factor: float = 0.3) -> tuple[str, bytes, bool]:
-    """
-    Attempt to download a single segment, retrying on failure.
-    Returns a tuple of the URL, content (empty if failed after retries), and a success flag.
-    """
-    for attempt in range(retries):
-        try:
-            response = requests.get(url, timeout=timeout)
-            response.raise_for_status()  # Raises stored HTTPError, if one occurred.
-            return (url, response.content, True)  # Success
-        except requests.RequestException as e:
-            print(f"Retry {attempt + 1} for {url}: {e}")
-            time.sleep(backoff_factor * (2 ** attempt))  # Exponential backoff
-
-    # After all retries have failed
-    return (url, b'', False)  # Failed download
-
-
-def threaded(max_workers: int = 20, timeout: int = 10, retries: int = 3):
-    """
-    Creates a wrapper function for the actual download process, with retry logic.
-    """
-    def wrapper(video, quality, callback, path):
-        """
-        Download video segments in parallel, with retries for failures, and write to a file.
-        """
-        segments = video.get_segments(quality=quality)
-        length = len(segments)
-        completed, successful_downloads = 0, 0
-
-        with ThreadPoolExecutor(max_workers=max_workers) as executor:
-            # Map the last part of the URL (filename) to the future
-            future_to_hls_part = {executor.submit(download_segment, url, timeout, retries): os.path.basename(url) for url in segments}
-
-            for future in as_completed(future_to_hls_part):
-                hls_part = future_to_hls_part[future]
-                try:
-                    _, data, success = future.result()
-                    completed += 1
-                    if success:
-                        successful_downloads += 1
-                    callback(completed, length)  # Update callback regardless of success to reflect progress
-                except Exception as e:
-                    raise e
-
-        # Writing only successful downloads to the file
-        with open(path, 'wb') as file:
-            for segment_url in segments:
-                # Find the future object using the HLS part of the URL as the key
-                matched_futures = [future for future, hls_part in future_to_hls_part.items() if hls_part == os.path.basename(segment_url)]
-                if matched_futures:
-                    logging.info("Got a match")
-                    future = matched_futures[0]  # Assuming unique HLS parts, take the first match
-                    try:
-                        _, data, success = future.result()
-                        if success:
-                            file.write(data)
-                    except Exception as e:
-                        pass  # Optionally handle or log the exception here
-
-    return wrapper
-
-
-def default(video, quality, callback, path, start: int = 0) -> bool:
-    buffer = b''
-    segments = video.get_segments(quality)[start:]
-    length = len(segments)
-
-    for i, url in enumerate(segments):
-        for _ in range(5):
-
-            segment = requests.get(url)
-
-            if segment.ok:
-                buffer += segment.content
-                callback(i + 1, length)
-                break
-
-    with open(path, 'wb') as file:
-        file.write(buffer)
-
-    return True
-
-
-def FFMPEG(video, quality, callback, path, start=0) -> bool:
-    base_url = video.m3u8_base_url
-    new_segment = video.get_m3u8_by_quality(quality)
-    url_components = base_url.split('/')
-    url_components[-1] = new_segment
-    new_url = '/'.join(url_components)
-
-    # Build the command for FFMPEG as a list directly
-    command = [
-        FFMPEG_PATH,
-        "-i", new_url,  # Input URL
-        "-bsf:a", "aac_adtstoasc",
-        "-y",  # Overwrite output files without asking
-        "-c", "copy",  # Copy streams without reencoding
-        path  # Output file path
-    ]
-
-    # Initialize FfmpegProgress and execute the command
-    ff = FfmpegProgress(command)
-    for progress in ff.run_command_with_progress():
-        # Update the callback with the current progress
-        callback(int(round(progress)), 100)
-
-        if progress == 100:
-            return True
-
-    return False
-
-
-def legacy_download(stream, path, url, callback=None):
-    response = requests.get(url, stream=stream)
-    file_size = int(response.headers.get('content-length', 0))
-
-    if callback is None:
-        progress_bar = Callback()
-
-    downloaded_so_far = 0
-
-    if not os.path.exists(path):
-        with open(path, 'wb') as file:
-            for chunk in response.iter_content(chunk_size=1024):
-                file.write(chunk)
-                downloaded_so_far += len(chunk)
-
-                if callback:
-                    callback(downloaded_so_far, file_size)
-
-                else:
-                    progress_bar.text_progress_bar(downloaded=downloaded_so_far, total=file_size)
-
-        if not callback:
-            del progress_bar
-
-        return True
-
-    else:
-        raise FileExistsError("The file already exists.")

eaf_base_api-1.6.3/base_api/modules/quality.py

@@ -1,7 +0,0 @@
-from enum import Enum
-
-
-class Quality(Enum):
-    BEST = 'BEST'
-    HALF = 'HALF'
-    WORST = 'WORST'

eaf_base_api-1.6.3/eaf_base_api.egg-info/PKG-INFO

@@ -1,44 +0,0 @@
-Metadata-Version: 2.1
-Name: eaf_base_api
-Version: 1.6.3
-Summary: A base API for EchterAlsFake's Porn APIs
-Home-page: https://github.com/EchterAlsFake/eaf_base_api
-Author: Johannes Habel
-Author-email: EchterAlsFake@proton.me
-License: LGPLv3
-Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
-Classifier: Programming Language :: Python
-Description-Content-Type: text/markdown
-Requires-Dist: requests
-Requires-Dist: ffmpeg-progress-yield
-
-# EAF Base API
-
-! Still in Development
-
-This Python package is a base api for all my Porn Site APIs. A lot of sites use the same methods, and
-there's a lot of code that I've rewritten again and again. This is why I created this base api, so that 
-I need to write less code and everything is easier to be maintainable. 
-
-# PRs
-Pull Requests are welcome, but if you make changes run `pytest` on all APIs that are using this to make sure your
-PR didn't break anything.
-
-# Documentation
-
-As this is some kind of 'raw' base API, this won't be documented, as it's only functional when used together
-with the main APIs. 
-
-Maybe you can look at the code comments. They could be helpful
-
-# Implementation
-You are welcome to implement this API in your own projects. If it's useful... But I don't recommend this, as things
-might change without a warning. But things like the threaded downloads can be useful for other projects :) 
-
-I'd say the threaded modes from the download module are already very well optimized, so feel free to just copy them
-for your own projects. You don't need to do any attribution, I don't care :) 
-
-
-# License
-
-LGPLv3