pkscreener 0.46.20250221.728__tar.gz → 0.46.20250221.731__tar.gz

{pkscreener-0.46.20250221.728 → pkscreener-0.46.20250221.731}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.2
 Name: pkscreener
-Version: 0.46.20250221.728
+Version: 0.46.20250221.731
 Summary: A Python-based stock screener for NSE, India with alerts to Telegram Channel (pkscreener)
 Home-page: https://github.com/pkjmesra/pkscreener
-Download-URL: https://github.com/pkjmesra/pkscreener/archive/v0.46.20250221.728.zip
+Download-URL: https://github.com/pkjmesra/pkscreener/archive/v0.46.20250221.731.zip
 Author: pkjmesra
 Author-email: pkjmesra@gmail.com
 License: OSI Approved (MIT)
@@ -33,7 +33,7 @@ Requires-Dist: pandas
 Requires-Dist: pandas_ta
 Requires-Dist: pefile<2024.8.26,>=2023.2.7
 Requires-Dist: Pillow
-Requires-Dist: PKDevTools>=0.13.20250126.236
+Requires-Dist: PKDevTools>=0.13.20250126.238
 Requires-Dist: PKNSETools>=0.1.20250122.138
 Requires-Dist: Pyarrow
 Requires-Dist: pyppeteer
@@ -392,15 +392,15 @@ After you have finished the run, go to that copied path, zip the contents of the
 [MADE-IN-INDIA-badge]: https://img.shields.io/badge/MADE%20WITH%20%E2%9D%A4%20IN-INDIA-orange
 [MADE-IN-INDIA]: https://en.wikipedia.org/wiki/India
 [Windows-badge]: https://img.shields.io/badge/Windows-0078D6?logo=windows&logoColor=white
-[Windows]: https://github.com/pkjmesra/PKScreener/releases/download/0.46.20250220.727/pkscreenercli.exe
+[Windows]: https://github.com/pkjmesra/PKScreener/releases/download/0.46.20250221.729/pkscreenercli.exe
 [Linux-badge_x64]: https://img.shields.io/badge/Linux(x64)-FCC624?logo=linux&logoColor=black
-[Linux_x64]: https://github.com/pkjmesra/PKScreener/releases/download/0.46.20250220.727/pkscreenercli_x64.bin
+[Linux_x64]: https://github.com/pkjmesra/PKScreener/releases/download/0.46.20250221.729/pkscreenercli_x64.bin
 [Linux-badge_arm64]: https://img.shields.io/badge/Linux(arm64)-FCC624?logo=linux&logoColor=black
-[Linux_arm64]: https://github.com/pkjmesra/PKScreener/releases/download/0.46.20250220.727/pkscreenercli_arm64.bin
+[Linux_arm64]: https://github.com/pkjmesra/PKScreener/releases/download/0.46.20250221.729/pkscreenercli_arm64.bin
 [Mac OS-badge_x64]: https://img.shields.io/badge/mac%20os(x64)-D3D3D3?logo=apple&logoColor=000000
-[Mac OS_x64]: https://github.com/pkjmesra/PKScreener/releases/download/0.46.20250220.727/pkscreenercli_x64.run
+[Mac OS_x64]: https://github.com/pkjmesra/PKScreener/releases/download/0.46.20250221.729/pkscreenercli_x64.run
 [Mac OS-badge_arm64]: https://img.shields.io/badge/mac%20os(arm64)-D3D3D3?logo=apple&logoColor=000000
-[Mac OS_arm64]: https://github.com/pkjmesra/PKScreener/releases/download/0.46.20250220.727/pkscreenercli_arm64.run
+[Mac OS_arm64]: https://github.com/pkjmesra/PKScreener/releases/download/0.46.20250221.729/pkscreenercli_arm64.run
 [GitHub release (latest by date)-badge]: https://img.shields.io/github/v/release/pkjmesra/PKScreener
 [GitHub release (latest by date)]: https://github.com/pkjmesra/PKScreener/releases/latest
 [pypi-badge]: https://img.shields.io/pypi/v/pkscreener.svg?style=flat-square

{pkscreener-0.46.20250221.728 → pkscreener-0.46.20250221.731}/README.md

@@ -328,15 +328,15 @@ After you have finished the run, go to that copied path, zip the contents of the
 [MADE-IN-INDIA-badge]: https://img.shields.io/badge/MADE%20WITH%20%E2%9D%A4%20IN-INDIA-orange
 [MADE-IN-INDIA]: https://en.wikipedia.org/wiki/India
 [Windows-badge]: https://img.shields.io/badge/Windows-0078D6?logo=windows&logoColor=white
-[Windows]: https://github.com/pkjmesra/PKScreener/releases/download/0.46.20250220.727/pkscreenercli.exe
+[Windows]: https://github.com/pkjmesra/PKScreener/releases/download/0.46.20250221.729/pkscreenercli.exe
 [Linux-badge_x64]: https://img.shields.io/badge/Linux(x64)-FCC624?logo=linux&logoColor=black
-[Linux_x64]: https://github.com/pkjmesra/PKScreener/releases/download/0.46.20250220.727/pkscreenercli_x64.bin
+[Linux_x64]: https://github.com/pkjmesra/PKScreener/releases/download/0.46.20250221.729/pkscreenercli_x64.bin
 [Linux-badge_arm64]: https://img.shields.io/badge/Linux(arm64)-FCC624?logo=linux&logoColor=black
-[Linux_arm64]: https://github.com/pkjmesra/PKScreener/releases/download/0.46.20250220.727/pkscreenercli_arm64.bin
+[Linux_arm64]: https://github.com/pkjmesra/PKScreener/releases/download/0.46.20250221.729/pkscreenercli_arm64.bin
 [Mac OS-badge_x64]: https://img.shields.io/badge/mac%20os(x64)-D3D3D3?logo=apple&logoColor=000000
-[Mac OS_x64]: https://github.com/pkjmesra/PKScreener/releases/download/0.46.20250220.727/pkscreenercli_x64.run
+[Mac OS_x64]: https://github.com/pkjmesra/PKScreener/releases/download/0.46.20250221.729/pkscreenercli_x64.run
 [Mac OS-badge_arm64]: https://img.shields.io/badge/mac%20os(arm64)-D3D3D3?logo=apple&logoColor=000000
-[Mac OS_arm64]: https://github.com/pkjmesra/PKScreener/releases/download/0.46.20250220.727/pkscreenercli_arm64.run
+[Mac OS_arm64]: https://github.com/pkjmesra/PKScreener/releases/download/0.46.20250221.729/pkscreenercli_arm64.run
 [GitHub release (latest by date)-badge]: https://img.shields.io/github/v/release/pkjmesra/PKScreener
 [GitHub release (latest by date)]: https://github.com/pkjmesra/PKScreener/releases/latest
 [pypi-badge]: https://img.shields.io/pypi/v/pkscreener.svg?style=flat-square

{pkscreener-0.46.20250221.728 → pkscreener-0.46.20250221.731}/pkscreener/README.txt

@@ -328,15 +328,15 @@ After you have finished the run, go to that copied path, zip the contents of the
 [MADE-IN-INDIA-badge]: https://img.shields.io/badge/MADE%20WITH%20%E2%9D%A4%20IN-INDIA-orange
 [MADE-IN-INDIA]: https://en.wikipedia.org/wiki/India
 [Windows-badge]: https://img.shields.io/badge/Windows-0078D6?logo=windows&logoColor=white
-[Windows]: https://github.com/pkjmesra/PKScreener/releases/download/0.46.20250220.727/pkscreenercli.exe
+[Windows]: https://github.com/pkjmesra/PKScreener/releases/download/0.46.20250221.729/pkscreenercli.exe
 [Linux-badge_x64]: https://img.shields.io/badge/Linux(x64)-FCC624?logo=linux&logoColor=black
-[Linux_x64]: https://github.com/pkjmesra/PKScreener/releases/download/0.46.20250220.727/pkscreenercli_x64.bin
+[Linux_x64]: https://github.com/pkjmesra/PKScreener/releases/download/0.46.20250221.729/pkscreenercli_x64.bin
 [Linux-badge_arm64]: https://img.shields.io/badge/Linux(arm64)-FCC624?logo=linux&logoColor=black
-[Linux_arm64]: https://github.com/pkjmesra/PKScreener/releases/download/0.46.20250220.727/pkscreenercli_arm64.bin
+[Linux_arm64]: https://github.com/pkjmesra/PKScreener/releases/download/0.46.20250221.729/pkscreenercli_arm64.bin
 [Mac OS-badge_x64]: https://img.shields.io/badge/mac%20os(x64)-D3D3D3?logo=apple&logoColor=000000
-[Mac OS_x64]: https://github.com/pkjmesra/PKScreener/releases/download/0.46.20250220.727/pkscreenercli_x64.run
+[Mac OS_x64]: https://github.com/pkjmesra/PKScreener/releases/download/0.46.20250221.729/pkscreenercli_x64.run
 [Mac OS-badge_arm64]: https://img.shields.io/badge/mac%20os(arm64)-D3D3D3?logo=apple&logoColor=000000
-[Mac OS_arm64]: https://github.com/pkjmesra/PKScreener/releases/download/0.46.20250220.727/pkscreenercli_arm64.run
+[Mac OS_arm64]: https://github.com/pkjmesra/PKScreener/releases/download/0.46.20250221.729/pkscreenercli_arm64.run
 [GitHub release (latest by date)-badge]: https://img.shields.io/github/v/release/pkjmesra/PKScreener
 [GitHub release (latest by date)]: https://github.com/pkjmesra/PKScreener/releases/latest
 [pypi-badge]: https://img.shields.io/pypi/v/pkscreener.svg?style=flat-square

pkscreener-0.46.20250221.731/pkscreener/classes/PKAnalytics.py

@@ -0,0 +1,157 @@
+#!/usr/bin/python3
+"""
+    The MIT License (MIT)
+
+    Copyright (c) 2023 pkjmesra
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all
+    copies or substantial portions of the Software.
+
+    THE 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.
+
+"""
+
+import os
+# import base64
+from sys import platform
+import platform
+import getpass
+# import git
+import json
+# import io
+import time
+from PKDevTools.classes.Fetcher import fetcher
+from PKDevTools.classes.Utils import random_user_agent
+# from PKDevTools.classes.PKDateUtilities import PKDateUtilities
+# from PKDevTools.classes import Archiver
+from PKDevTools.classes.Singleton import SingletonType, SingletonMixin
+from PKDevTools.classes.pubsub.publisher import PKUserService
+from PKDevTools.classes.pubsub.subscriber import notification_service
+from pkscreener.classes import VERSION
+
+class PKAnalyticsService(SingletonMixin, metaclass=SingletonType):
+    def __init__(self):
+        super(PKAnalyticsService, self).__init__()
+        self.username = ""
+        self.locationInfo = ""
+        self.os = platform.system()
+        self.os_version = platform.release()
+        self.app_version = VERSION
+        self.start_time = time.time()
+        self.isRunner = "RUNNER" in os.environ.keys()
+
+    def collectMetrics(self,user=None):
+        try:
+            self.userName = self.getUserName()
+            metrics = self.getApproxLocationInfo()
+            self.locationInfo = metrics
+            self.send_event("app_start")
+        except KeyboardInterrupt: # pragma: no cover
+            raise KeyboardInterrupt
+        except Exception as e: # pragma: no cover
+            pass
+
+    def getUserName(self):
+        try:
+            username = os.getlogin()
+            if username is None or len(username) == 0:
+                username = os.environ.get('username') if platform.startswith("win") else os.environ.get("USER")
+                if username is None or len(username) == 0:
+                    username = os.environ.get('USERPROFILE')
+                    if username is None or len(username) == 0:
+                        username = os.path.expandvars("%userprofile%") if platform.startswith("win") else getpass.getuser()
+        except KeyboardInterrupt: # pragma: no cover
+            raise KeyboardInterrupt
+        except: # pragma: no cover
+            username = f"Unidentified-{self.os}"
+            pass
+        return username
+
+    def getApproxLocationInfo(self):
+        try:
+            url = 'http://ipinfo.io/json'
+            f = fetcher()
+            response = f.fetchURL(url=url,timeout=5,headers={'user-agent': f'{random_user_agent()}'})
+            data = json.loads(response.text)
+        except: # pragma: no cover
+            data = {"locationInfo":f"Unidentified-{self.os}"}
+            pass
+        return data
+    
+    def send_event(self,event_name,params={}):
+        event_params = {
+            "user_id": self.userName,
+            "os": self.os,
+            "os_version": self.os_version,
+            "app_version": self.app_version,
+            "elapsed_time": str(time.time() - self.start_time),
+            "is_Runner": self.isRunner
+        }
+        if len(params) > 0:
+            for key in params:
+                event_params[key] = params[key]
+        if self.isRunner:
+            try:
+                owner = os.popen('git ls-remote --get-url origin | cut -d/ -f4').read().replace("\n","")
+                repo = os.popen('git ls-remote --get-url origin | cut -d/ -f5').read().replace(".git","").replace("\n","")
+                event_params["repo_owner"] = owner
+                event_params["repo"] = repo
+            except:
+                pass
+        for key in self.locationInfo.keys():
+            if key not in ["readme"]:
+                event_params[key] = self.locationInfo[key]
+        PKUserService().send_event(event_name, event_params)
+        
+    # def tryCommitAnalytics(self, userDict={},username="Unidentified"):
+    #     import git.repo
+    #     repo_clone_url = "https://github.com/pkjmesra/PKUserAnalytics.git"
+    #     local_repo = os.path.join(Archiver.get_user_data_dir(),"PKUserAnalytics")
+    #     try:
+    #         test_branch = "main"
+    #         repo = git.Repo.clone_from(repo_clone_url, local_repo)
+    #         repo.git.checkout(test_branch)
+    #     except Exception as e: # pragma: no cover
+    #         repo = git.Repo(local_repo)
+    #         repo.git.checkout(test_branch)
+    #         pass
+    #     remote = git.remote.Remote(repo=repo,name="origin")
+    #     repo.git.reset('--hard','origin/main')
+    #     remote.pull()
+    #     # write to file in working directory
+    #     scanResultFilesPath = os.path.join(local_repo, f"users-{PKDateUtilities.currentDateTime().strftime('%Y-%m-%d')}.txt")
+    #     records = {}
+    #     existingUserRecords = [userDict]
+    #     mode = "rb+" if os.path.exists(scanResultFilesPath) else "wb+"
+    #     with open(scanResultFilesPath, mode) as f:
+    #         allUsers = f.read()
+    #         if allUsers is not None and len(allUsers) > 0:
+    #             allUsers = base64.b64decode(allUsers).decode("utf-8").replace("'","\"")
+    #             records = json.loads(allUsers)
+    #             if records is None:
+    #                 records = {}
+    #             existingUserRecords = records.get(username)
+    #             if existingUserRecords is not None:
+    #                 existingUserRecords.append(userDict)
+    #             else:
+    #                 existingUserRecords = [userDict]
+    #         records[username] = existingUserRecords
+    #         encoded = base64.b64encode(bytes(str(records).replace("'","\""), "utf-8"))
+    #         f.writelines(io.BytesIO(encoded))
+    #     repo.index.add([scanResultFilesPath])
+    #     repo.index.commit("[User-Analytics]")
+    #     remote = git.remote.Remote(repo=repo,name="origin")
+    #     remote.push()

{pkscreener-0.46.20250221.728 → pkscreener-0.46.20250221.731}/pkscreener/classes/PKUserRegistration.py

@@ -94,6 +94,8 @@ class PKUserRegistration(SingletonMixin, metaclass=SingletonType):
     @classmethod
     def login(self, trialCount=0):
         try:
+            from pkscreener.classes.PKAnalytics import PKAnalyticsService
+            PKAnalyticsService().collectMetrics()
             if "RUNNER" in os.environ.keys():
                 return ValidationResult.Success
         except: # pragma: no cover

pkscreener-0.46.20250221.731/pkscreener/classes/__init__.py

@@ -0,0 +1 @@
+VERSION='0.46.20250221.731'

{pkscreener-0.46.20250221.728 → pkscreener-0.46.20250221.731}/pkscreener/globals.py

@@ -110,6 +110,7 @@ from pkscreener.classes.PKScanRunner import PKScanRunner
 from pkscreener.classes.PKMarketOpenCloseAnalyser import PKMarketOpenCloseAnalyser
 from pkscreener.classes.PKPremiumHandler import PKPremiumHandler
 from pkscreener.classes.AssetsManager import PKAssetsManager
+from pkscreener.classes.PKAnalytics import PKAnalyticsService
 
 if __name__ == '__main__':
     multiprocessing.freeze_support()
@@ -214,6 +215,7 @@ def getDownloadChoices(defaultAnswer=None):
                 + colorText.END
                 + " already exists. Exiting as user chose not to replace it!"
             )
+            PKAnalyticsService().send_event("app_exit")
             sys.exit(0)
         else:
             pattern = f"{'intraday_' if intraday else ''}stock_data_*.pkl"
@@ -268,6 +270,7 @@ def getScannerMenuChoices(
             + "  [+] Press <Enter> to Exit!"
             + colorText.END
         )
+        PKAnalyticsService().send_event("app_exit")
         sys.exit(0)
     except Exception as e:  # pragma: no cover
         default_logger().debug(e, exc_info=True)
@@ -573,6 +576,7 @@ def initExecution(menuOption=None):
                     + "  [+] Press <Enter> to Exit!"
                     + colorText.END
                 )
+                PKAnalyticsService().send_event("app_exit")
                 sys.exit(0)
             elif selectedMenu.menuKey in ["B", "C", "G", "H", "U", "T", "S", "E", "X", "Y", "M", "D", "I", "L","F"]:
                 ConsoleUtility.PKConsoleTools.clearScreen(forceTop=True)
@@ -679,6 +683,7 @@ def initPostLevel1Execution(indexOption, executeOption=None, skip=[], retrial=Fa
             if indexOption == "S":
                 ensureMenusLoaded("X",indexOption,executeOption)
                 if not PKPremiumHandler.hasPremium(selectedMenu):
+                    PKAnalyticsService().send_event("app_exit")
                     sys.exit(0)
                 indexKeys = level1_index_options_sectoral.keys()
                 stockIndexCode = input(
@@ -917,6 +922,7 @@ def main(userArgs=None,optionalFinalOutcome_df=None):
         mkt_monitor_dict = mp_manager.dict()
         # Let's start monitoring the market monitor
         startMarketMonitor(mkt_monitor_dict,keyboardInterruptEvent)
+        PKAnalyticsService().send_event("market_monitor_started")
         
     keyboardInterruptEventFired = False
     if stockDictPrimary is None:
@@ -947,12 +953,15 @@ def main(userArgs=None,optionalFinalOutcome_df=None):
     if menuOption in ["F", "M", "S", "B", "G", "C", "P", "D"] or selectedMenu.isPremium:
         ensureMenusLoaded(menuOption,indexOption,executeOption)
         if not PKPremiumHandler.hasPremium(selectedMenu):
+            PKAnalyticsService().send_event(f"non_premium_user_{menuOption}")
+            PKAnalyticsService().send_event("app_exit")
             sys.exit(0)
     if menuOption in ["M", "D", "I", "L", "F"]:
         launcher = f'"{sys.argv[0]}"' if " " in sys.argv[0] else sys.argv[0]
         launcher = f"python3.12 {launcher}" if (launcher.endswith(".py\"") or launcher.endswith(".py")) else launcher
         if menuOption in ["M"]:
             OutputControls().printOutput(f"{colorText.GREEN}Launching PKScreener in monitoring mode. If it does not launch, please try with the following:{colorText.END}\n{colorText.FAIL}{launcher} --systemlaunched -a Y -m 'X'{colorText.END}\n{colorText.WARN}Press Ctrl + C to exit monitoring mode.{colorText.END}")
+            PKAnalyticsService().send_event(f"monitor_{menuOption}")
             sleep(2)
             os.system(f"{launcher} --systemlaunched -a Y -m 'X'")
         elif menuOption in ["D"]:
@@ -963,11 +972,13 @@ def main(userArgs=None,optionalFinalOutcome_df=None):
             OutputControls().printOutput(colorText.END, end="")
             if selDownloadOption.upper() == "D":
                 OutputControls().printOutput(f"{colorText.GREEN}Launching PKScreener to Download daily OHLC data. If it does not launch, please try with the following:{colorText.END}\n{colorText.FAIL}{launcher} -a Y -e -d{colorText.END}\n{colorText.WARN}Press Ctrl + C to exit at any time.{colorText.END}")
+                PKAnalyticsService().send_event(f"{menuOption}_{selDownloadOption.upper()}")
                 sleep(2)
                 os.system(f"{launcher} -a Y -e -d")
                 return None, None
             elif selDownloadOption.upper() == "I":
                 OutputControls().printOutput(f"{colorText.GREEN}Launching PKScreener to Download intraday OHLC data. If it does not launch, please try with the following:{colorText.END}\n{colorText.FAIL}{launcher} -a Y -e -d -i 1m{colorText.END}\n{colorText.WARN}Press Ctrl + C to exit at any time.{colorText.END}")
+                PKAnalyticsService().send_event(f"{menuOption}_{selDownloadOption.upper()}")
                 sleep(2)
                 os.system(f"{launcher} -a Y -e -d -i 1m")
                 return None, None
@@ -975,6 +986,7 @@ def main(userArgs=None,optionalFinalOutcome_df=None):
                 selectedMenu = m1.find(selDownloadOption.upper())
                 ConsoleUtility.PKConsoleTools.clearScreen(forceTop=True)
                 m2.renderForMenu(selectedMenu)
+                PKAnalyticsService().send_event(f"{menuOption}_{selDownloadOption.upper()}")
                 selDownloadOption = input(colorText.FAIL + "  [+] Select option: ") or "12"
                 OutputControls().printOutput(colorText.END, end="")
                 filePrefix = "Download"
@@ -986,6 +998,7 @@ def main(userArgs=None,optionalFinalOutcome_df=None):
                     + ".csv"
                 )
                 filePath = os.path.join(Archiver.get_user_indices_dir(), filename)
+                PKAnalyticsService().send_event(f"{menuOption}_{selDownloadOption.upper()}")
                 if selDownloadOption.upper() == "15":
                     nasdaq = PKNasdaqIndexFetcher(configManager)
                     _,nasdaq_df = nasdaq.fetchNasdaqIndexConstituents()
@@ -998,6 +1011,7 @@ def main(userArgs=None,optionalFinalOutcome_df=None):
                     input(f"{colorText.GREEN}Press any key to continue...{colorText.END}")
                     return None, None
                 elif selDownloadOption.upper() == "M":
+                    PKAnalyticsService().send_event(f"{menuOption}_{selDownloadOption.upper()}")
                     return None, None
                 else:
                     fileContents = fetcher.fetchFileFromHostServer(filePath=filePath,tickerOption=int(selDownloadOption),fileContents="")
@@ -1022,12 +1036,14 @@ def main(userArgs=None,optionalFinalOutcome_df=None):
                     + PKDateUtilities.currentDateTime().strftime("%d-%m-%y_%H.%M.%S")
                     + ".csv"
                 )
+                PKAnalyticsService().send_event(f"{menuOption}_{selDownloadOption.upper()}")
                 filePath = os.path.join(Archiver.get_user_reports_dir(), filename)
                 if selDownloadOption.upper() == "M":
                     return None, None
                 else:
                     indexOption = int(selDownloadOption)
                     if indexOption > 0 and indexOption <= 14:
+                        PKAnalyticsService().send_event(f"{menuOption}_{selDownloadOption.upper()}")
                         shouldSuppress = not OutputControls().enableMultipleLineOutput
                         with SuppressOutput(suppress_stderr=shouldSuppress, suppress_stdout=shouldSuppress):
                             listStockCodes = fetcher.fetchStockCodes(indexOption, stockCode=None)
@@ -1043,12 +1059,15 @@ def main(userArgs=None,optionalFinalOutcome_df=None):
                             OutputControls().printOutput(f"{colorText.FAIL}We encountered an error. Please try again!{colorText.END}")
                         input(f"{colorText.GREEN}Press any key to continue...{colorText.END}")
             elif selDownloadOption.upper() == "M":
+                PKAnalyticsService().send_event(f"{menuOption}_{selDownloadOption.upper()}")
                 return None, None
         elif menuOption in ["L"]:
+            PKAnalyticsService().send_event(f"{menuOption}")
             OutputControls().printOutput(f"{colorText.GREEN}Launching PKScreener to collect logs. If it does not launch, please try with the following:{colorText.END}\n{colorText.FAIL}{launcher} -a Y -l{colorText.END}\n{colorText.WARN}Press Ctrl + C to exit at any time.{colorText.END}")
             sleep(2)
             os.system(f"{launcher} -a Y -l")
         if menuOption in ["F"]:
+            PKAnalyticsService().send_event(f"{menuOption}")
             indexOption = 0
             selectedChoice["0"] = "F"
             selectedChoice["1"] = "0"
@@ -1754,7 +1773,7 @@ def main(userArgs=None,optionalFinalOutcome_df=None):
                 maLength = float(maLength)
                 if maLength > 0:
                     maLength = 0 - maLength
-
+    
     if executeOption == MAX_MENU_OPTION:
         ConsoleUtility.PKConsoleTools.getLastScreenedResults(defaultAnswer)
         return None, None
@@ -1770,6 +1789,7 @@ def main(userArgs=None,optionalFinalOutcome_df=None):
     if str(indexOption).isnumeric() and int(indexOption) > 1 and executeOption <= MAX_SUPPORTED_MENU_OPTION:
         ensureMenusLoaded(menuOption,indexOption,executeOption)
         if not PKPremiumHandler.hasPremium(m2.find(str(executeOption).upper())):
+            PKAnalyticsService().send_event("app_exit")
             sys.exit(0)
     if (
         not str(indexOption).isnumeric() and str(indexOption).upper() in ["W", "E", "M", "N", "Z", "S"]
@@ -1781,6 +1801,7 @@ def main(userArgs=None,optionalFinalOutcome_df=None):
         try:
             if str(indexOption).upper() in ["W", "E", "S"]:
                 if not PKPremiumHandler.hasPremium(m1.find(str(indexOption).upper())):
+                    PKAnalyticsService().send_event("app_exit")
                     sys.exit(0)
             if indexOption == "W":
                 listStockCodes = fetcher.fetchWatchlist()
@@ -1790,6 +1811,7 @@ def main(userArgs=None,optionalFinalOutcome_df=None):
                         + f"  [+] Please create the watchlist.xlsx file in {os.getcwd()} and Restart the Program!"
                         + colorText.END
                     )
+                    PKAnalyticsService().send_event("app_exit")
                     sys.exit(0)
             elif indexOption == "N":
                 os.environ["TF_CPP_MIN_LOG_LEVEL"] = "3"
@@ -1824,6 +1846,7 @@ def main(userArgs=None,optionalFinalOutcome_df=None):
                     + "  [+] Press <Enter> to Exit!"
                     + colorText.END
                 )
+                PKAnalyticsService().send_event("app_exit")
                 sys.exit(0)
             elif indexOption == "E":
                 return handleMonitorFiveEMA()
@@ -1885,7 +1908,6 @@ def main(userArgs=None,optionalFinalOutcome_df=None):
             except: # pragma: no cover
                 stockDictPrimary,stockDictSecondary = loadDatabaseOrFetch(downloadOnly, listStockCodes, menuOption, indexOption)
                 pass
-            
         loadCount = len(stockDictPrimary) if stockDictPrimary is not None else 0
         # Let's use screening only for the stocks for which we could get the data.
         savedOrDownloadedKeys = list(stockDictPrimary.keys())
@@ -2179,6 +2201,7 @@ def main(userArgs=None,optionalFinalOutcome_df=None):
             OutputControls().printOutput(colorText.END, end="")
             ensureMenusLoaded(menuOption,indexOption,executeOption)
             if not PKPremiumHandler.hasPremium(m0.find(str(pinOption).upper())):
+                PKAnalyticsService().send_event("app_exit")
                 sys.exit(0)
             if pinOption in ["1","2"]:
                 if pinOption in ["2"]:
@@ -2508,7 +2531,6 @@ def addOrRunPipedMenus():
 def describeUser():
     if not configManager.enableUsageAnalytics:
         return
-    from pkscreener.classes.PKAnalytics import PKAnalyticsService
     service = PKAnalyticsService()
     func_args = None
     task = PKTask("Usage Analytics",
@@ -2736,6 +2758,7 @@ def handleExitRequest(executeOption):
             + "  [+] Press <Enter> to Exit!"
             + colorText.END
         )
+        PKAnalyticsService().send_event("app_exit")
         sys.exit(0)
 
 def handleMenu_XBG(menuOption, indexOption, executeOption):
@@ -2845,7 +2868,7 @@ def updateMenuChoiceHierarchy():
     if ((":0:" in runOptionName or "_0_" in runOptionName) and userPassedArgs.progressstatus is not None) or userPassedArgs.progressstatus is not None:
         runOptionName = userPassedArgs.progressstatus.split("=>")[0].split("  [+] ")[1].strip()
     reportTitle = f"{runOptionName} | {reportTitle}" if runOptionName is not None else reportTitle
-
+    PKAnalyticsService().send_event(runOptionName)
     OutputControls().printOutput(
         colorText.FAIL
         + f"  [+] You chose: {reportTitle} "
@@ -3840,6 +3863,7 @@ def saveDownloadedData(downloadOnly, testing, stockDictPrimary, configManager, l
                     os.system(f"{launcher} -a Y -e -l -d {'-i 1m' if configManager.isIntradayConfig() else ''}")
                 else:
                     del os.environ['PKDevTools_Default_Log_Level']
+                    PKAnalyticsService().send_event("app_exit")
                     sys.exit(0)
     else:
         OutputControls().printOutput(colorText.GREEN + "  [+] Skipped Saving!" + colorText.END)
@@ -3915,6 +3939,7 @@ def sendGlobalMarketBarometer(userArgs=None):
             )
             os.remove(gmbPath)
         else:
+            PKAnalyticsService().send_event("app_exit")
             sys.exit(0)
     except Exception as e: # pragma: no cover
         default_logger().debug(e,exc_info=True)

{pkscreener-0.46.20250221.728 → pkscreener-0.46.20250221.731}/pkscreener/pkscreenerbot.py

@@ -70,6 +70,7 @@ from PKDevTools.classes.GmailReader import PKGmailReader
 from pkscreener.classes.MenuOptions import MenuRenderStyle, menu, menus,MAX_MENU_OPTION
 from pkscreener.classes.WorkflowManager import run_workflow
 import pkscreener.classes.ConfigManager as ConfigManager
+from pkscreener.classes.PKAnalytics import PKAnalyticsService
 try:
     from PKDevTools.classes.DBManager import DBManager
     from PKDevTools.classes.UserSubscriptions import PKUserSusbscriptions
@@ -1422,9 +1423,14 @@ def isUserSubscribed(user):
 
 def launchScreener(options, user, context, optionChoices, update):
     try:
-        if not isUserSubscribed(user):
+        scanRequest = optionChoices.replace(" ", "").replace(">", "_").replace(":","_").replace("_D","").upper()
+        userSubs = isUserSubscribed(user)
+        try:
+            PKAnalyticsService().send_event("bot_scan",{"bot_userid":str(user.id), "bot_username":str(user.username),"scan_id":str(scanRequest),"user_subscribed":userSubs})
+        except:
+            pass
+        if not userSubs:
             basicSubscriptions = ["X_0","X_N","X_1_"]
-            scanRequest = optionChoices.replace(" ", "").replace(">", "_").replace(":","_").replace("_D","").upper()
             isBasicScanRequest = False
             for basicSub in basicSubscriptions:
                 if basicSub in scanRequest:

{pkscreener-0.46.20250221.728 → pkscreener-0.46.20250221.731}/pkscreener/requirements.txt

@@ -19,7 +19,7 @@ pandas_ta #>=0.3.14b0
 # and https://github.com/pyinstaller/pyinstaller/issues/7269
 pefile>=2023.2.7,<2024.8.26
 Pillow #>=9.5.0,<=9.5.0 # Keep at this version because getsize_multiline is deprecated/removed in higher versions
-PKDevTools>=0.13.20250126.236
+PKDevTools>=0.13.20250126.238
 PKNSETools>=0.1.20250122.138
 Pyarrow #>=17.0.0
 pyppeteer #>=2.0.0

{pkscreener-0.46.20250221.728 → pkscreener-0.46.20250221.731}/pkscreener.egg-info/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.2
 Name: pkscreener
-Version: 0.46.20250221.728
+Version: 0.46.20250221.731
 Summary: A Python-based stock screener for NSE, India with alerts to Telegram Channel (pkscreener)
 Home-page: https://github.com/pkjmesra/pkscreener
-Download-URL: https://github.com/pkjmesra/pkscreener/archive/v0.46.20250221.728.zip
+Download-URL: https://github.com/pkjmesra/pkscreener/archive/v0.46.20250221.731.zip
 Author: pkjmesra
 Author-email: pkjmesra@gmail.com
 License: OSI Approved (MIT)
@@ -33,7 +33,7 @@ Requires-Dist: pandas
 Requires-Dist: pandas_ta
 Requires-Dist: pefile<2024.8.26,>=2023.2.7
 Requires-Dist: Pillow
-Requires-Dist: PKDevTools>=0.13.20250126.236
+Requires-Dist: PKDevTools>=0.13.20250126.238
 Requires-Dist: PKNSETools>=0.1.20250122.138
 Requires-Dist: Pyarrow
 Requires-Dist: pyppeteer
@@ -392,15 +392,15 @@ After you have finished the run, go to that copied path, zip the contents of the
 [MADE-IN-INDIA-badge]: https://img.shields.io/badge/MADE%20WITH%20%E2%9D%A4%20IN-INDIA-orange
 [MADE-IN-INDIA]: https://en.wikipedia.org/wiki/India
 [Windows-badge]: https://img.shields.io/badge/Windows-0078D6?logo=windows&logoColor=white
-[Windows]: https://github.com/pkjmesra/PKScreener/releases/download/0.46.20250220.727/pkscreenercli.exe
+[Windows]: https://github.com/pkjmesra/PKScreener/releases/download/0.46.20250221.729/pkscreenercli.exe
 [Linux-badge_x64]: https://img.shields.io/badge/Linux(x64)-FCC624?logo=linux&logoColor=black
-[Linux_x64]: https://github.com/pkjmesra/PKScreener/releases/download/0.46.20250220.727/pkscreenercli_x64.bin
+[Linux_x64]: https://github.com/pkjmesra/PKScreener/releases/download/0.46.20250221.729/pkscreenercli_x64.bin
 [Linux-badge_arm64]: https://img.shields.io/badge/Linux(arm64)-FCC624?logo=linux&logoColor=black
-[Linux_arm64]: https://github.com/pkjmesra/PKScreener/releases/download/0.46.20250220.727/pkscreenercli_arm64.bin
+[Linux_arm64]: https://github.com/pkjmesra/PKScreener/releases/download/0.46.20250221.729/pkscreenercli_arm64.bin
 [Mac OS-badge_x64]: https://img.shields.io/badge/mac%20os(x64)-D3D3D3?logo=apple&logoColor=000000
-[Mac OS_x64]: https://github.com/pkjmesra/PKScreener/releases/download/0.46.20250220.727/pkscreenercli_x64.run
+[Mac OS_x64]: https://github.com/pkjmesra/PKScreener/releases/download/0.46.20250221.729/pkscreenercli_x64.run
 [Mac OS-badge_arm64]: https://img.shields.io/badge/mac%20os(arm64)-D3D3D3?logo=apple&logoColor=000000
-[Mac OS_arm64]: https://github.com/pkjmesra/PKScreener/releases/download/0.46.20250220.727/pkscreenercli_arm64.run
+[Mac OS_arm64]: https://github.com/pkjmesra/PKScreener/releases/download/0.46.20250221.729/pkscreenercli_arm64.run
 [GitHub release (latest by date)-badge]: https://img.shields.io/github/v/release/pkjmesra/PKScreener
 [GitHub release (latest by date)]: https://github.com/pkjmesra/PKScreener/releases/latest
 [pypi-badge]: https://img.shields.io/pypi/v/pkscreener.svg?style=flat-square

{pkscreener-0.46.20250221.728 → pkscreener-0.46.20250221.731}/pkscreener.egg-info/requires.txt

@@ -15,7 +15,7 @@ pandas
 pandas_ta
 pefile<2024.8.26,>=2023.2.7
 Pillow
-PKDevTools>=0.13.20250126.236
+PKDevTools>=0.13.20250126.238
 PKNSETools>=0.1.20250122.138
 Pyarrow
 pyppeteer

pkscreener-0.46.20250221.728/pkscreener/classes/PKAnalytics.py

@@ -1,122 +0,0 @@
-#!/usr/bin/python3
-"""
-    The MIT License (MIT)
-
-    Copyright (c) 2023 pkjmesra
-
-    Permission is hereby granted, free of charge, to any person obtaining a copy
-    of this software and associated documentation files (the "Software"), to deal
-    in the Software without restriction, including without limitation the rights
-    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-    copies of the Software, and to permit persons to whom the Software is
-    furnished to do so, subject to the following conditions:
-
-    The above copyright notice and this permission notice shall be included in all
-    copies or substantial portions of the Software.
-
-    THE 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.
-
-"""
-
-import os
-import base64
-from sys import platform
-import platform
-import getpass
-import git
-import json
-import io
-
-from PKDevTools.classes.Fetcher import fetcher
-from PKDevTools.classes.Utils import random_user_agent
-from PKDevTools.classes.PKDateUtilities import PKDateUtilities
-from PKDevTools.classes import Archiver
-import git.repo
-
-class PKAnalyticsService():
-    def collectMetrics(self,user=None):
-        try:
-            userName = self.getUserName()
-            metrics = self.getApproxLocationInfo()
-            dateTime = str(PKDateUtilities.currentDateTime())
-            metrics["dateTime"] = dateTime
-            metrics["userName"] = userName
-            if "readme" in metrics.keys():
-                del metrics['readme']
-            self.tryCommitAnalytics(userDict=metrics,username=userName)
-        except KeyboardInterrupt: # pragma: no cover
-            raise KeyboardInterrupt
-        except Exception as e: # pragma: no cover
-            pass
-
-    def getUserName(self):
-        try:
-            username = os.getlogin()
-            if username is None or len(username) == 0:
-                username = os.environ.get('username') if platform.startswith("win") else os.environ.get("USER")
-                if username is None or len(username) == 0:
-                    username = os.environ.get('USERPROFILE')
-                    if username is None or len(username) == 0:
-                        username = os.path.expandvars("%userprofile%") if platform.startswith("win") else getpass.getuser()
-        except KeyboardInterrupt: # pragma: no cover
-            raise KeyboardInterrupt
-        except: # pragma: no cover
-            username = f"Unidentified-{platform.system()}"
-            pass
-        return username
-
-    def getApproxLocationInfo(self):
-        try:
-            url = 'http://ipinfo.io/json'
-            f = fetcher()
-            response = f.fetchURL(url=url,timeout=5,headers={'user-agent': f'{random_user_agent()}'})
-            data = json.loads(response.text)
-        except: # pragma: no cover
-            data = {"locationInfo":f"Unidentified-{platform.system()}"}
-            pass
-        return data
-    
-    def tryCommitAnalytics(self, userDict={},username="Unidentified"):
-        repo_clone_url = "https://github.com/pkjmesra/PKUserAnalytics.git"
-        local_repo = os.path.join(Archiver.get_user_data_dir(),"PKUserAnalytics")
-        try:
-            test_branch = "main"
-            repo = git.Repo.clone_from(repo_clone_url, local_repo)
-            repo.git.checkout(test_branch)
-        except Exception as e: # pragma: no cover
-            repo = git.Repo(local_repo)
-            repo.git.checkout(test_branch)
-            pass
-        remote = git.remote.Remote(repo=repo,name="origin")
-        repo.git.reset('--hard','origin/main')
-        remote.pull()
-        # write to file in working directory
-        scanResultFilesPath = os.path.join(local_repo, f"users-{PKDateUtilities.currentDateTime().strftime('%Y-%m-%d')}.txt")
-        records = {}
-        existingUserRecords = [userDict]
-        mode = "rb+" if os.path.exists(scanResultFilesPath) else "wb+"
-        with open(scanResultFilesPath, mode) as f:
-            allUsers = f.read()
-            if allUsers is not None and len(allUsers) > 0:
-                allUsers = base64.b64decode(allUsers).decode("utf-8").replace("'","\"")
-                records = json.loads(allUsers)
-                if records is None:
-                    records = {}
-                existingUserRecords = records.get(username)
-                if existingUserRecords is not None:
-                    existingUserRecords.append(userDict)
-                else:
-                    existingUserRecords = [userDict]
-            records[username] = existingUserRecords
-            encoded = base64.b64encode(bytes(str(records).replace("'","\""), "utf-8"))
-            f.writelines(io.BytesIO(encoded))
-        repo.index.add([scanResultFilesPath])
-        repo.index.commit("[User-Analytics]")
-        remote = git.remote.Remote(repo=repo,name="origin")
-        remote.push()

pkscreener-0.46.20250221.728/pkscreener/classes/__init__.py

@@ -1 +0,0 @@
-VERSION='0.46.20250221.728'