Merge pull request #1010 from luxonis/feat/sentryio

Add sentry.io reporting, add CLI command depthai-sdk

Author: daniilpastukhov

depthai_sdk/requirements.txt

@@ -7,4 +7,5 @@ pytube>=12.1.0
 depthai==2.21.2
 PyTurboJPEG==1.6.4
 marshmallow==3.17.0
-xmltodict
+xmltodict
+sentry-sdk==1.21.0

depthai_sdk/setup.py

@@ -18,8 +18,8 @@
     author='Luxonis',
     author_email='support@luxonis.com',
     license='MIT',
-    packages=['depthai_sdk'],
-    package_dir={"": "src"},  # https://stackoverflow.com/a/67238346/5494277
+    packages=['depthai_sdk', 'depthai_sdk_console_scripts'],
+    package_dir={'': 'src'},  # https://stackoverflow.com/a/67238346/5494277
     install_requires=install_requires,
     include_package_data=True,
     extras_require={
@@ -30,14 +30,7 @@
         "replay": ['mcap>=0.0.10',
                    'mcap-ros1-support==0.0.8',
                    'rosbags==0.9.11'],
-        "record": ['av'],
-        "minimal": ['numpy',
-                    'blobconverter',
-                    'depthai',
-                    'PyTurboJPEG',
-                    'marshmallow',
-                    'xmltodict',
-                    ]
+        "record": ['av']
     },
     project_urls={
         "Bug Tracker": "https://github.com/luxonis/depthai/issues",
@@ -53,4 +46,9 @@
         "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: 3.10",
     ],
+    entry_points={
+        'console_scripts': [
+            'depthai_sdk = depthai_sdk_console_scripts.depthai_sdk:main',
+        ]
+    },
 )

depthai_sdk/src/depthai_sdk/__init__.py

@@ -7,4 +7,36 @@
 from depthai_sdk.record import *
 from depthai_sdk.replay import *
 from depthai_sdk.utils import *
+from depthai_sdk.utils import _create_config, get_config_field
 from depthai_sdk.visualize import *
+
+__version__ = '1.9.6'
+
+
+def __import_sentry(sentry_dsn: str) -> None:
+    try:
+        import sentry_sdk
+
+        sentry_sdk.init(
+            dsn=sentry_dsn,
+            traces_sample_rate=1.0,
+            release='depthai_sdk@1.9.5',
+            with_locals=False,
+        )
+    except:
+        pass
+
+
+config_exists = False
+# Check if sentry is enabled
+try:
+    sentry_status = get_config_field('sentry')
+    config_exists = True
+except FileNotFoundError:
+    sentry_status = False
+
+if config_exists and sentry_status:
+    sentry_dsn = get_config_field('sentry_dsn')
+    __import_sentry(sentry_dsn)
+elif not config_exists:
+    _create_config()

depthai_sdk/src/depthai_sdk/utils.py

@@ -1,8 +1,10 @@
 import importlib
+import json
+import logging
 import sys
 import urllib.request
 from pathlib import Path
-from typing import Dict, List, Tuple, Optional, Union
+from typing import Dict, List, Tuple, Optional, Union, Any
 
 try:
     import cv2
@@ -391,3 +393,77 @@ def createBlankFrame(width, height, rgb_color=(0, 0, 0)):
     image[:] = color
 
     return image
+
+
+def _create_cache_folder() -> bool:
+    """
+    Create config file in user's home directory.
+
+    Returns:
+        True if folder was created, False otherwise.
+    """
+    try:
+        Path.home().joinpath(".depthai_sdk").mkdir(parents=True, exist_ok=True)
+    except PermissionError:
+        logging.debug('Failed to create cache folder.')
+        return False
+
+    return True
+
+
+def _create_config() -> None:
+    """
+    Create config file in user's home directory.
+
+    Returns:
+        None.
+    """
+    if not _create_cache_folder():
+        logging.debug('Failed to create config file.')
+        return
+
+    config_file = Path.home().joinpath('.depthai_sdk', 'config.json')
+    default_config = {
+        'sentry': True,
+        'sentry_dsn': 'https://981545d5effd480d883f3ff0b1306e49@o1095304.ingest.sentry.io/4504685274791936'
+    }
+    if not config_file.exists():
+        config_file.write_text(json.dumps(default_config))
+
+
+def set_sentry_status(status: bool = True) -> None:
+    """
+    Set sentry status in config file.
+
+    Args:
+        status (bool): True if sentry should be enabled, False otherwise. Default is True.
+
+    Returns:
+        None.
+    """
+    # check if config exists
+    config_file = Path.home().joinpath('.depthai_sdk', 'config.json')
+    if not config_file.exists():
+        _create_config()
+
+    # read config
+    config = json.loads(config_file.read_text())
+    config['sentry'] = status
+    config_file.write_text(json.dumps(config))
+
+
+def get_config_field(key: str) -> Any:
+    """
+    Get sentry status from config file.
+
+    Returns:
+        bool: True if sentry is enabled, False otherwise.
+    """
+    # check if config exists
+    config_file = Path.home().joinpath('.depthai_sdk', 'config.json')
+    if not config_file.exists():
+        raise FileNotFoundError('Config file not found.')
+
+    # read config
+    config = json.loads(config_file.read_text())
+    return config[key]

depthai_sdk/src/depthai_sdk_console_scripts/__init__.py

@@ -0,0 +1 @@
+from .__main__ import main

depthai_sdk/src/depthai_sdk_console_scripts/depthai_sdk/__init__.py

@@ -0,0 +1,28 @@
+import argparse
+
+import depthai_sdk
+
+
+def main():
+    parser = argparse.ArgumentParser(description='DepthAI SDK command-line interface.')
+    subparsers = parser.add_subparsers(dest='command')
+
+    sentry_parser = subparsers.add_parser('sentry', help='Enable or disable Sentry reporting')
+    sentry_parser.add_argument('action', choices=['enable', 'disable', 'status'], help='Action to perform')
+
+    args = parser.parse_args()
+
+    if args.command == 'sentry':
+        if args.action == 'enable':
+            depthai_sdk.set_sentry_status(True)
+            print('Sentry reporting was enabled.')
+        elif args.action == 'disable':
+            depthai_sdk.set_sentry_status(False)
+            print('Sentry reporting was disabled.')
+        elif args.action == 'status':
+            status = depthai_sdk.get_config_field("sentry")
+            print(f'Sentry is {"enabled" if status else "disabled"}.')
+
+
+if __name__ == '__main__':
+    main()