splashscreen-engine 2.0.6__tar.gz → 2.0.7__tar.gz

splashscreen_engine-2.0.7/Analytics.py

@@ -0,0 +1,179 @@
+# Required Modules
+import requests
+
+# Pre-Installed Modules
+import platform
+import datetime
+import json
+import uuid
+from pathlib import Path
+import os
+from typing import Any
+
+
+# Firebase Database URL
+DATABASE_URL = "https://splashscreenanalytics-default-rtdb.europe-west1.firebasedatabase.app"
+
+
+class Analyse:
+
+    def __init__(self):
+
+        # ------- MAKING FRAMEWORK FOLDER ----------
+
+        # Getting File Path for Windows
+        if platform.system() == "Windows":
+
+            local_appdata = os.getenv("LOCALAPPDATA")
+            if not local_appdata:
+                # Unable to find app data, so don't break the framework and stop analytics
+                self.success = False
+                return
+            self.APP_DIR = Path(local_appdata) / "SplashScreenEngine"
+
+
+        # Getting File Path for Linux / macOS
+        else:
+            self.APP_DIR = Path.home() / ".SplashScreenEngine"
+
+        self.success = True # File Path Created
+
+        # Create Folder
+        self.APP_DIR.mkdir(exist_ok=True)
+
+
+        # JSON File Path
+        self.DATA_FILE = self.APP_DIR / "SplashData.json"
+
+        # Default Data Structure
+        self.DATA: dict[str,Any] = {
+
+            # Unique User ID
+            "user_id": str(uuid.uuid4()),
+
+            # OS type
+            "OS": platform.system(),
+
+            # Error Logs
+            "errors": {},
+
+            # Functions Used
+            "functions_used": {},
+
+            # Last Usage Time
+            "last_usage": None,
+
+            # Program running time (seconds)
+            "runtime": None,
+
+            # Total Runtime of module usage till it was installed
+            "total_runtime": 0.0
+        }
+
+
+        # Other required variables
+        self.start_time = None
+
+
+        self.file_exists()
+        self.start()
+
+
+    # Checks if file exists and openable
+    def file_exists(self):
+
+        # Return if path not created
+        if not self.success:
+            return
+
+        try :
+            # Create JSON File if not exists
+            if not self.DATA_FILE.exists():
+
+                # Create JSON File
+                with open(self.DATA_FILE, "w") as f:
+                    json.dump(self.DATA, f, indent=4)
+
+            # Save JSON File as dictionary in `DATA` variable if exists
+            else:
+
+                with open(self.DATA_FILE, "r") as f:
+                    self.DATA = json.load(f)
+
+        # If unable to create/read file
+        except Exception as e:
+            self.DATA["errors"][self.DATA["user_id"]] = str(e)
+            self.success = False
+
+    # Start Analyzing Data
+    def start(self):
+
+        # Return if path not created
+        if not self.success:
+            return
+
+        self.start_time = datetime.datetime.now()
+
+    # Store which functions used and store usage time
+    def append_function(self,func_name):
+
+        # Return if path not created
+        if not self.success:
+            return
+
+        current_time = datetime.datetime.now().strftime("%Y-%m-%d_%H-%M-%S-%f")
+        self.DATA["functions_used"][current_time] = func_name
+
+    # Store Errors
+    def add_error(self,error):
+
+        # Return if path not created
+        if not self.success:
+            return
+
+        current_time = datetime.datetime.now().strftime("%Y-%m-%d_%H-%M-%S-%f")
+        self.DATA["errors"][current_time] = str(error)
+
+    # save all the data at the end
+    def save(self):
+
+        if self.start_time is None:
+            return
+
+        # Return if path not created
+        if not self.success:
+            return
+
+        current_time = datetime.datetime.now()
+        runtime = (current_time - self.start_time).total_seconds()
+        total_runtime = float(self.DATA["total_runtime"]) + float(runtime)
+        current_time = current_time.strftime("%Y-%m-%d_%H-%M-%S-%f")
+
+        self.DATA["total_runtime"] = total_runtime
+        self.DATA["runtime"] = runtime
+        self.DATA["last_usage"] = current_time
+
+
+        try:
+            response = requests.post(
+
+                f"{DATABASE_URL}/analytics.json",
+
+                json=self.DATA,
+
+                timeout=3
+            )
+            response.raise_for_status()
+
+        except Exception as e:
+            self.add_error(e)
+
+
+        # Save Everything in the json file
+        try:
+            with open(self.DATA_FILE, "w") as f:
+                json.dump(self.DATA, f, indent=4)
+        except Exception as e:
+            self.add_error(e)
+
+

{splashscreen_engine-2.0.6 → splashscreen_engine-2.0.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: splashscreen-engine
-Version: 2.0.6
+Version: 2.0.7
 Summary: A Python framework for creating splash screens with videos, images, animated loading bars, threaded rendering, transparency, and dynamic UI support.
 Home-page: https://github.com/NamanChhabra21/splashscreen-engine
 Author: Naman Chhabra
@@ -10,25 +10,29 @@ Project-URL: Source, https://github.com/NamanChhabra21/splashscreen-engine
 Project-URL: Issues, https://github.com/NamanChhabra21/splashscreen-engine/issues
 Project-URL: Discussions, https://github.com/NamanChhabra21/splashscreen-engine/discussions
 Project-URL: PyPI, https://pypi.org/project/splashscreen-engine/
-Keywords: pygame,splash-screen,loading-screen,opencv,video-rendering,pygame-framework,python-gui,animation,desktop-app,threaded-rendering,video-loader,splashscreen,loading-bar,multimedia
+Keywords: pygame,splash-screen,loading-screen,opencv,video-rendering,pygame-framework,python-gui,animation,desktop-app,threaded-rendering,video-loader,splashscreen,loading-bar,multimedia,splash
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: Microsoft :: Windows
 Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Multimedia :: Graphics
 Classifier: Topic :: Multimedia :: Video
 Classifier: Topic :: Games/Entertainment
+Classifier: Topic :: Multimedia
+Classifier: Topic :: Desktop Environment
 Classifier: Intended Audience :: Developers
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 Requires-Dist: pygame
 Requires-Dist: opencv-python
 Requires-Dist: numpy
+Requires-Dist: requests
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier

{splashscreen_engine-2.0.6 → splashscreen_engine-2.0.7}/setup.py

@@ -6,17 +6,19 @@ with open("README.md", "r", encoding="utf-8") as f:
 setup(
     name="splashscreen-engine",
 
-    version="2.0.6",
+    version="2.0.7",
 
     py_modules=[
         "splashscreen_engine",
-        "video_renderer"
+        "video_renderer",
+        "Analytics"
     ],
 
     install_requires=[
         "pygame",
         "opencv-python",
-        "numpy"
+        "numpy",
+        "requests"
     ],
 
     author="Naman Chhabra",
@@ -58,7 +60,8 @@ setup(
         "video-loader",
         "splashscreen",
         "loading-bar",
-        "multimedia"
+        "multimedia",
+        "splash"
     ],
 
     classifiers=[
@@ -68,6 +71,7 @@ setup(
         "Programming Language :: Python :: 3.10",
         "Programming Language :: Python :: 3.11",
         "Programming Language :: Python :: 3.12",
+        "Programming Language :: Python :: 3.13",
 
         "License :: OSI Approved :: MIT License",
 
@@ -77,6 +81,8 @@ setup(
         "Topic :: Multimedia :: Graphics",
         "Topic :: Multimedia :: Video",
         "Topic :: Games/Entertainment",
+        "Topic :: Multimedia",
+        "Topic :: Desktop Environment",
 
         "Intended Audience :: Developers"
     ],

{splashscreen_engine-2.0.6 → splashscreen_engine-2.0.7}/splashscreen_engine.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: splashscreen-engine
-Version: 2.0.6
+Version: 2.0.7
 Summary: A Python framework for creating splash screens with videos, images, animated loading bars, threaded rendering, transparency, and dynamic UI support.
 Home-page: https://github.com/NamanChhabra21/splashscreen-engine
 Author: Naman Chhabra
@@ -10,25 +10,29 @@ Project-URL: Source, https://github.com/NamanChhabra21/splashscreen-engine
 Project-URL: Issues, https://github.com/NamanChhabra21/splashscreen-engine/issues
 Project-URL: Discussions, https://github.com/NamanChhabra21/splashscreen-engine/discussions
 Project-URL: PyPI, https://pypi.org/project/splashscreen-engine/
-Keywords: pygame,splash-screen,loading-screen,opencv,video-rendering,pygame-framework,python-gui,animation,desktop-app,threaded-rendering,video-loader,splashscreen,loading-bar,multimedia
+Keywords: pygame,splash-screen,loading-screen,opencv,video-rendering,pygame-framework,python-gui,animation,desktop-app,threaded-rendering,video-loader,splashscreen,loading-bar,multimedia,splash
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: Microsoft :: Windows
 Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Multimedia :: Graphics
 Classifier: Topic :: Multimedia :: Video
 Classifier: Topic :: Games/Entertainment
+Classifier: Topic :: Multimedia
+Classifier: Topic :: Desktop Environment
 Classifier: Intended Audience :: Developers
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 Requires-Dist: pygame
 Requires-Dist: opencv-python
 Requires-Dist: numpy
+Requires-Dist: requests
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier

{splashscreen_engine-2.0.6 → splashscreen_engine-2.0.7}/splashscreen_engine.egg-info/SOURCES.txt

@@ -1,3 +1,4 @@
+Analytics.py
 README.md
 setup.py
 splashscreen_engine.py

{splashscreen_engine-2.0.6 → splashscreen_engine-2.0.7}/splashscreen_engine.egg-info/requires.txt

@@ -1,3 +1,4 @@
 pygame
 opencv-python
 numpy
+requests

{splashscreen_engine-2.0.6 → splashscreen_engine-2.0.7}/splashscreen_engine.egg-info/top_level.txt

@@ -1,2 +1,3 @@
+Analytics
 splashscreen_engine
 video_renderer

{splashscreen_engine-2.0.6 → splashscreen_engine-2.0.7}/splashscreen_engine.py

@@ -3,19 +3,22 @@ import threading
 import time
 
 
-
 # Hide pygame Welcome Message and centralize the screen
 os.environ['PYGAME_HIDE_SUPPORT_PROMPT'] = "hide"
 s = '1'
 os.environ['SDL_VIDEO_CENTERED'] = s
 
-# Modules
+# Required Modules
 import pygame
 
 # Engine Files
 import video_renderer
+import Analytics
 
+# Setup Analysis
+analyse = Analytics.Analyse()
 
+# Required Variables to check if the program is stopped or not
 deleted_by_user = False
 program_stopped = False
 
@@ -169,6 +172,8 @@ class Screen:
 
     def __init__(self,title_bar=False):
 
+
+
         if not pygame.get_init():
             pygame.init()
 
@@ -228,10 +233,12 @@ class Screen:
 
 
     def get_size(self):
+        analyse.append_function("get_size()")
         return self.width,self.height
 
     def start(self):
 
+        analyse.append_function("start()")
 
         self.running = True
 
@@ -261,6 +268,7 @@ class Screen:
         def mainloop():
             global program_stopped
 
+
             if not self.screen:
                 self.start()
 
@@ -324,10 +332,13 @@ class Screen:
                 self.clock.tick(60)
             global deleted_by_user
             deleted_by_user = True
+
         threading.Thread(target=mainloop).start() # Starts Mainloop as background process
 
     def stop(self,quit_pygame = True):
 
+        analyse.append_function("stop()")
+
         # Stops the Window
         self.running = False
         self.stopped = True
@@ -340,10 +351,13 @@ class Screen:
         if quit_pygame:
             pygame.quit()
 
+        analyse.save() # save Analysis Data in firebase
+
 
 
     def size(self, width=750, height=500, fullscreen=False):
 
+        analyse.append_function("size()")
 
         # Check if width and height is integer and more than 0
         if (
@@ -393,6 +407,8 @@ class Screen:
 
     def title(self, text="Splash Screen"):
 
+        analyse.append_function("title")
+
         self.caption = text.strip()
 
         pygame.display.set_caption(self.caption)
@@ -400,6 +416,7 @@ class Screen:
     @staticmethod
     def wait(seconds):
 
+
         if seconds <= 1:
 
             avoid_lag()
@@ -418,9 +435,14 @@ class Screen:
 
     def set_bg_color(self, color=(0, 0, 0)):
 
+        analyse.append_function("set_bg_color()")
+
         self.bgColor = color
 
     def set_icon(self,path):
+
+        analyse.append_function("set_icon()")
+
         if not self.title_bar:
             raise RuntimeError("Unable to set Icon, Title Bar is disabled.")
         self.icon = path
@@ -430,11 +452,16 @@ class Screen:
 
 
     def is_quit(self):
+
+        analyse.append_function("is_quit")
+
         if not self.title_bar:
             raise RuntimeError("`is_quit` only works if you enable Title Bar.")
 
+
         return program_stopped # True if quit else False
     def is_escaped(self):
+
         if not self.title_bar:
             raise RuntimeError("`is_escaped` only works if Title Bar is enabled.")
         escape = self.is_escape
@@ -446,6 +473,8 @@ class BackgroundVideo:
 
     def __init__(self, screen_object, path, fps=30,loop=False):
 
+        analyse.append_function("BackgroundVideo()")
+
         # ONLY SCREEN ALLOWED
         if not isinstance(screen_object, Screen):
 
@@ -483,6 +512,8 @@ class BackgroundVideo:
 
     def play(self):
 
+        analyse.append_function("play()")
+
         self.stop = False
 
         self.is_playing = True
@@ -542,12 +573,16 @@ class BackgroundVideo:
 
     def pause(self):
 
+        analyse.append_function("pause()")
+
         self.stop = True
 
         self.is_playing = False
 
     def resume(self):
 
+        analyse.append_function("resume()")
+
         if self.stop:
             self.stop = False
 
@@ -556,6 +591,8 @@ class BackgroundVideo:
 
     def delete(self):
 
+        analyse.append_function("delete()")
+
         self.pause()
 
         self.video.reset_frames()
@@ -563,6 +600,8 @@ class BackgroundVideo:
 
     def transparency(self, level=120):
 
+        analyse.append_function("transparency()")
+
         if level < 0:
             level = 0
 
@@ -575,12 +614,16 @@ class BackgroundVideo:
 
     def stop_transparency(self):
 
+        analyse.append_function("stop_transparency()")
+
         self.transparent = False
 
     def stop_loop(self):
+        analyse.append_function("stop_loop()")
         self.loop = False
 
     def playing(self):
+        analyse.append_function("playing()")
         return self.is_playing
 
 
@@ -588,6 +631,8 @@ class BackgroundImage:
 
     def __init__(self, parent, path):
 
+        analyse.append_function("BackgroundImage()")
+
         # ONLY SCREEN ALLOWED
         if not isinstance(parent, Screen):
 
@@ -605,13 +650,17 @@ class BackgroundImage:
         self.image = self.original_image
 
     def set(self):
+        analyse.append_function("set()")
         self.parent.current_background = self
 
 
 class LoadingBar:
 
+
     def __init__(self, parent, width=None, height=None,position="center",add_xy = (0,0)):
 
+        analyse.append_function("LoadingBar()")
+
         check_valid_pos(position,"LoadingBar")
         self.position = position.lower()
         self.add_xy = add_xy  # adds / subtract the value of x-axis and y-axis from the chosen position
@@ -664,6 +713,7 @@ class LoadingBar:
             colour=(255, 255, 255),
             loading_colour=(0, 255, 0)
     ):
+        analyse.append_function("Bar: place()")
 
         self.colour = colour
 
@@ -672,7 +722,7 @@ class LoadingBar:
         self.visible = True
 
     def hide(self):
-
+        analyse.append_function("hide()")
         self.visible = False
 
     def set_progress(self, value):
@@ -687,6 +737,7 @@ class LoadingBar:
         self.progress = value
 
     def set_video(self,path):
+        analyse.append_function("set_video")
         self.video = video_renderer.Vid(path)
 
 
@@ -694,12 +745,17 @@ def check_valid_pos(string,object_type):
     available_position = ["right", "left", "down", "up", "center",None]
     if string not in available_position:
         available_position.pop() # Remove `None` for displaying Available positions
+
+        analyse.add_error("Wrong Argument in check_valid_pos")
+
         raise RuntimeError(f"`{object_type}` object got unknown positional argument. Please choose from {available_position}")
 
 class Text:
 
     def __init__(self,parent,text="Your Text Here",font=None,size=20,position="center",add_xy = (0,0),colour=(255, 255, 255)):
 
+        analyse.append_function("Text()")
+
         check_valid_pos(position,"Text")
         self.position = position.lower()
         self.add_xy = add_xy  # adds / subtract the value of x-axis and y-axis from the chosen position
@@ -722,6 +778,7 @@ class Text:
 
     def edit(self,text=None,font=None,new_size=None,position=None,add_xy=None,colour=None):
 
+
         if text is not None:
             self.text = text
 
@@ -744,13 +801,18 @@ class Text:
             self.colour = colour
 
     def hide(self):
+        analyse.append_function("Text Hidden")
         self.visible = False
 
     def show(self):
+        analyse.append_function("text show()")
         self.visible = True
 
 class Documentation:
     def __init__(self):
+
+        analyse.append_function("Documentation()")
+
         self.GithubReadMeLink = "https://github.com/NamanChhabra21/splashscreen-engine/blob/main/README.md"
         self.gmail = "chhabranaman21@gmail.com"
         self.ytChannel = "www.youtube.com/@GenZCoderZShorts"
@@ -760,8 +822,11 @@ class Documentation:
         self.discussions = "https://github.com/NamanChhabra21/splashscreen-engine/discussions"
 
     def open(self):
+
+        analyse.append_function("open documentation()")
         os.startfile(self.GithubReadMeLink)
     def contact(self):
+        analyse.append_function("contact()")
         print(f"For Contact & Feedback :\n\
               Github : {self.GithubLink}\n\
               PyPI : {self.pypi}\n\