Merge pull request #4 from rdavydov/switchable

Switchable Analytics

Author: rdavydov

README.md

@@ -571,6 +571,14 @@ The chart provides some annotation to handle the prediction and watch strike eve
 On each (x, y) points Its present a tooltip that show points, date time and reason of points gained / lost. This web page was just a funny idea, and it is not intended to use for a professional usage.
 If you want you can toggle the dark theme with the dedicated checkbox.
 
+### `enableAnalytics.py` file in the main directory toggles Analytics
+Disabling Analytics significantly reduces memory consumption and saves some disk space.
+
+- Remove this file if you don't need Analytics. Or rename it to something different, like `disableAnalytics.py`.
+- To enable Analytics back - just create this file again. Or rename it back to `enableAnalytics.py`.
+
+This file can be empty.
+
 | Light theme | Dark theme |
 | ----------- | ---------- |
 | ![Light theme](https://raw.githubusercontent.com/Tkd-Alex/Twitch-Channel-Points-Miner-v2/master/assets/chart-analytics-light.png) | ![Dark theme](https://raw.githubusercontent.com/Tkd-Alex/Twitch-Channel-Points-Miner-v2/master/assets/chart-analytics-dark.png) |

TwitchChannelPointsMiner/TwitchChannelPointsMiner.py

@@ -11,7 +11,6 @@
 from datetime import datetime
 from pathlib import Path
 
-from TwitchChannelPointsMiner.classes.AnalyticsServer import AnalyticsServer
 from TwitchChannelPointsMiner.classes.Chat import ChatPresence, ThreadChat
 from TwitchChannelPointsMiner.classes.entities.PubsubTopic import PubsubTopic
 from TwitchChannelPointsMiner.classes.entities.Streamer import (
@@ -32,6 +31,17 @@
     set_default_settings,
 )
 
+disableAnalytics = False
+
+try:
+    import enableAnalytics
+except ImportError:
+    disableAnalytics = True
+
+# Analytics switch
+if disableAnalytics is False:
+    from TwitchChannelPointsMiner.classes.AnalyticsServer import AnalyticsServer
+
 # Suppress:
 #   - chardet.charsetprober - [feed]
 #   - chardet.charsetprober - [get_confidence]
@@ -79,8 +89,10 @@ def __init__(
         # Default values for all streamers
         streamer_settings: StreamerSettings = StreamerSettings(),
     ):
-        Settings.analytics_path = os.path.join(Path().absolute(), "analytics", username)
-        Path(Settings.analytics_path).mkdir(parents=True, exist_ok=True)
+        # Analytics switch
+        if disableAnalytics is False:
+            Settings.analytics_path = os.path.join(Path().absolute(), "analytics", username)
+            Path(Settings.analytics_path).mkdir(parents=True, exist_ok=True)
 
         self.username = username
 
@@ -126,19 +138,21 @@ def __init__(
         for sign in [signal.SIGINT, signal.SIGSEGV, signal.SIGTERM]:
             signal.signal(sign, self.end)
 
-    def analytics(
-        self,
-        host: str = "127.0.0.1",
-        port: int = 5000,
-        refresh: int = 5,
-        days_ago: int = 7,
-    ):
-        http_server = AnalyticsServer(
-            host=host, port=port, refresh=refresh, days_ago=days_ago
-        )
-        http_server.daemon = True
-        http_server.name = "Analytics Thread"
-        http_server.start()
+    # Analytics switch
+    if disableAnalytics is False:
+        def analytics(
+            self,
+            host: str = "127.0.0.1",
+            port: int = 5000,
+            refresh: int = 5,
+            days_ago: int = 7,
+        ):
+            http_server = AnalyticsServer(
+                host=host, port=port, refresh=refresh, days_ago=days_ago
+            )
+            http_server.daemon = True
+            http_server.name = "Analytics Thread"
+            http_server.start()
 
     def mine(
         self,

TwitchChannelPointsMiner/classes/WebSocketsPool.py

@@ -17,6 +17,13 @@
     internet_connection_available,
 )
 
+disableAnalytics = False
+
+try:
+    import enableAnalytics
+except ImportError:
+    disableAnalytics = True
+
 logger = logging.getLogger(__name__)
 
 
@@ -170,19 +177,21 @@ def on_message(ws, message):
 
             ws.last_message_timestamp = message.timestamp
             ws.last_message_type_channel = message.identifier
-
+         
             streamer_index = get_streamer_index(ws.streamers, message.channel_id)
             if streamer_index != -1:
                 try:
                     if message.topic == "community-points-user-v1":
                         if message.type in ["points-earned", "points-spent"]:
                             balance = message.data["balance"]["balance"]
                             ws.streamers[streamer_index].channel_points = balance
-                            ws.streamers[streamer_index].persistent_series(
-                                event_type=message.data["point_gain"]["reason_code"]
-                                if message.type == "points-earned"
-                                else "Spent"
-                            )
+                            # Analytics switch
+                            if disableAnalytics is False:
+                                ws.streamers[streamer_index].persistent_series(
+                                    event_type=message.data["point_gain"]["reason_code"]
+                                    if message.type == "points-earned"
+                                    else "Spent"
+                                )
 
                         if message.type == "points-earned":
                             earned = message.data["point_gain"]["total_points"]
@@ -198,9 +207,11 @@ def on_message(ws, message):
                             ws.streamers[streamer_index].update_history(
                                 reason_code, earned
                             )
-                            ws.streamers[streamer_index].persistent_annotations(
-                                reason_code, f"+{earned} - {reason_code}"
-                            )
+                            # Analytics switch
+                            if disableAnalytics is False:
+                                ws.streamers[streamer_index].persistent_annotations(
+                                    reason_code, f"+{earned} - {reason_code}"
+                                )
                         elif message.type == "claim-available":
                             ws.twitch.claim_bonus(
                                 ws.streamers[streamer_index],

TwitchChannelPointsMiner/logger.py

@@ -68,7 +68,7 @@ class LoggerSettings:
         "color_palette",
         "auto_clear",
         "telegram",
-        "discord",
+        "discord"
     ]
 
     def __init__(

enableAnalytics.py

@@ -0,0 +1,4 @@
+# Significantly reduces memory consumption and saves some disk space.
+# Remove this file if you don't need Analytics. Or rename it to something different, like "disableAnalytics.py".
+# To enable Analytics back - just create this file again. Or rename it back to "enableAnalytics.py".
+# This file can be empty.