snapctl 0.49.5__py3-none-any.whl → 0.53.1__py3-none-any.whl

snapctl/commands/byogs.py

@@ -105,6 +105,16 @@ class ByoGs:
             pass
         return None
 
+    @staticmethod
+    def _docker_supports_buildkit():
+        try:
+            version = subprocess.check_output(
+                ["docker", "version", "--format", "{{.Server.Version}}"])
+            major, minor = map(int, version.decode().split(".")[:2])
+            return (major > 18) or (major == 18 and minor >= 9)
+        except Exception:
+            return False
+
     def _check_dependencies(self) -> None:
         progress = Progress(
             SpinnerColumn(),
@@ -200,6 +210,10 @@ class ByoGs:
         progress.add_task(
             description='Building your snap...', total=None)
         try:
+            env = os.environ.copy()
+            if ByoGs._docker_supports_buildkit():
+                info('Docker BuildKit is supported. Enabling it.')
+                env["DOCKER_BUILDKIT"] = "1"
             # image_tag = f'{ByoGs.SID}.{self.tag}'
             build_platform = ByoGs.DEFAULT_BUILD_PLATFORM
             if len(self.token_parts) == 4:
@@ -217,7 +231,7 @@ class ByoGs:
                     # f"docker build --no-cache -t {tag} {path}"
                     'docker', 'build', '--platform', build_platform, '-t', self.tag,
                     '-f', self.docker_path_filename,  self.path
-                ], shell=True, check=False)
+                ], shell=True, check=False, env=env)
                 # stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT)
             else:
                 response = subprocess.run([
@@ -225,7 +239,7 @@ class ByoGs:
                     "docker build --platform " +
                     f"{build_platform} -t {self.tag} " +
                     f"-f {self.docker_path_filename} {self.path}"
-                ], shell=True, check=False)
+                ], shell=True, check=False, env=env)
                 # stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT)
             if not response.returncode:
                 return snapctl_success(

snapctl/commands/byosnap.py

@@ -509,16 +509,19 @@ class ByoSnap:
                     outfile.write(line)
             return True
         except FileNotFoundError:
-            print(f"[ERROR] Could not find profile file: {resource_filename}")
+            warning(
+                f"[ERROR] Could not find profile file: {resource_filename}")
+            return False
+
+    @staticmethod
+    def _docker_supports_buildkit():
+        try:
+            version = subprocess.check_output(
+                ["docker", "version", "--format", "{{.Server.Version}}"])
+            major, minor = map(int, version.decode().split(".")[:2])
+            return (major > 18) or (major == 18 and minor >= 9)
+        except Exception:
             return False
-    # @staticmethod
-    # def _handle_output_file(input_filepath, output_filepath) -> bool:
-    #     file_written = False
-    #     with open(input_filepath, 'r') as in_file, open(output_filepath, 'w') as outfile:
-    #         for line in in_file:
-    #             outfile.write(line)
-    #         file_written = True
-    #     return file_written
 
     def _get_profile_contents(self) -> dict:
         """
@@ -588,13 +591,15 @@ class ByoSnap:
                 code=SNAPCTL_INPUT_ERROR
             )
         # IMPORTANT: This is where the profile data is set and validated
+        #
+        # Update: June 2, 2025 -  We removed the line that updated the self.platform_type
+        # self.platform_type = profile_data_obj['platform']
         self.profile_data = profile_data_obj
         ByoSnap._validate_byosnap_profile_data(self.profile_data)
         # End: IMPORTANT: This is where the profile data is set
         # Now apply the overrides
         self.name = self.profile_data['name']
         self.desc = self.profile_data['description']
-        self.platform_type = self.profile_data['platform']
         self.language = self.profile_data['language']
         self.prefix = self.profile_data['prefix']
         # Setup the final ingress external port
@@ -716,6 +721,10 @@ class ByoSnap:
         build_platform = ByoSnap.DEFAULT_BUILD_PLATFORM
         if len(self.token_parts) == 4:
             build_platform = self.token_parts[3]
+        if self.platform_type is not None:
+            build_platform = self.platform_type
+        # if len(self.token_parts) == 4:
+        #     build_platform = self.token_parts[3]
         progress = Progress(
             SpinnerColumn(),
             TextColumn("[progress.description]{task.description}"),
@@ -725,6 +734,10 @@ class ByoSnap:
         progress.add_task(
             description='Building your snap...', total=None)
         try:
+            env = os.environ.copy()
+            if ByoSnap._docker_supports_buildkit():
+                info('Docker BuildKit is supported. Enabling it.')
+                env["DOCKER_BUILDKIT"] = "1"
             # Warning check for architecture specific commands
             info(f'Building on system architecture {sys_platform.machine()}')
             check_response = check_dockerfile_architecture(
@@ -737,7 +750,7 @@ class ByoSnap:
                     # f"docker build --no-cache -t {remote_tag} {path}"
                     'docker', 'build', '--platform', build_platform, '-t', self.remote_tag,
                     '-f', self.docker_path_filename,  self.path
-                ], shell=True, check=False)
+                ], shell=True, check=False, env=env)
                 # stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT)
             else:
                 response = subprocess.run([
@@ -745,7 +758,7 @@ class ByoSnap:
                     "docker build --platform " +
                     f"{build_platform} -t {self.remote_tag} " +
                     f"-f {self.docker_path_filename} {self.path}"
-                ], shell=True, check=False)
+                ], shell=True, check=False, env=env)
                 # stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT)
             if not response.returncode:
                 return snapctl_success(
@@ -943,15 +956,21 @@ class ByoSnap:
             if self.path is None and self.resources_path is None:
                 snapctl_error(
                     "Missing one of: path or resources-path parameter", SNAPCTL_INPUT_ERROR)
-            if not self.tag:
-                snapctl_error("Missing tag", SNAPCTL_INPUT_ERROR)
-            if len(self.tag.split()) > 1 or \
-                    len(self.tag) > ByoSnap.TAG_CHARACTER_LIMIT:
-                snapctl_error(
-                    "Tag should be a single word with maximum of " +
-                    f"{ByoSnap.TAG_CHARACTER_LIMIT} characters",
-                    SNAPCTL_INPUT_ERROR
-                )
+            if not self.tag and not self.version:
+                snapctl_error("Missing tag or version", SNAPCTL_INPUT_ERROR)
+            if self.tag:
+                if len(self.tag.split()) > 1 or \
+                        len(self.tag) > ByoSnap.TAG_CHARACTER_LIMIT:
+                    snapctl_error(
+                        "Tag should be a single word with maximum of " +
+                        f"{ByoSnap.TAG_CHARACTER_LIMIT} characters",
+                        SNAPCTL_INPUT_ERROR
+                    )
+            if self.version:
+                pattern = r'^v\d+\.\d+\.\d+$'
+                if not re.match(pattern, self.version):
+                    snapctl_error(message="Version should be in the format vX.X.X",
+                                  code=SNAPCTL_INPUT_ERROR)
         elif self.subcommand == 'publish-version':
             # Setup
             self._setup_token_and_token_parts(
@@ -1127,6 +1146,9 @@ class ByoSnap:
         progress.add_task(
             description='Uploading your BYOSnap Docs...', total=None)
         try:
+            upload_tag = self.tag
+            if not upload_tag:
+                upload_tag = self.version
             if self.resources_path:
                 base_dir = self.resources_path
             else:
@@ -1141,7 +1163,7 @@ class ByoSnap:
                         info(f'Uploading swagger.json at {swagger_file}')
                         url = (
                             f"{self.base_url}/v1/snapser-api/byosnaps/"
-                            f"{self.byosnap_id}/docs/{self.tag}/openapispec"
+                            f"{self.byosnap_id}/docs/{upload_tag}/openapispec"
                         )
                         test_res = requests.post(
                             url, files={"attachment": attachment_file},
@@ -1181,7 +1203,7 @@ class ByoSnap:
                     with open(readme_file, "rb") as attachment_file:
                         url = (
                             f"{self.base_url}/v1/snapser-api/byosnaps/"
-                            f"{self.byosnap_id}/docs/{self.tag}/markdown"
+                            f"{self.byosnap_id}/docs/{upload_tag}/markdown"
                         )
                         test_res = requests.post(
                             url, files={"attachment": attachment_file},
@@ -1213,7 +1235,7 @@ class ByoSnap:
                             with open(file_path, "rb") as attachment_file:
                                 url = (
                                     f"{self.base_url}/v1/snapser-api/byosnaps/"
-                                    f"{self.byosnap_id}/docs/{self.tag}/tools"
+                                    f"{self.byosnap_id}/docs/{upload_tag}/tools"
                                 )
                                 test_res = requests.post(
                                     url, files={"attachment": attachment_file},
@@ -1370,7 +1392,11 @@ class ByoSnap:
                 "prod_template": prod_template,
                 # Currently not supported so we are just hardcoding an empty list
                 "egress": {"ports": []},
+                # Platform override
             }
+            if self.platform_type is not None:
+                payload['platform_override'] = self.platform_type
+
             res = requests.post(
                 f"{self.base_url}/v1/snapser-api/byosnaps/{self.byosnap_id}/versions",
                 json=payload, headers={'api-key': self.api_key},
@@ -1452,6 +1478,8 @@ class ByoSnap:
                 # Currently not supported so we are just hardcoding an empty list
                 "egress": {"ports": []},
             }
+            if self.platform_type is not None:
+                payload['platform_override'] = self.platform_type
             res = requests.patch(
                 f"{self.base_url}/v1/snapser-api/byosnaps/{self.byosnap_id}/versions/{self.version}",
                 json=payload, headers={'api-key': self.api_key},
@@ -1504,7 +1532,7 @@ class ByoSnap:
                 "service_id": self.byosnap_id,
                 "name": self.name,
                 "description": self.desc,
-                "platform": self.platform_type,
+                "platform": self.profile_data['platform'],
                 "language": self.language,
             }
             res = requests.post(

snapctl/commands/byows.py

@@ -20,7 +20,6 @@ from snapctl.config.constants import SERVER_CALL_TIMEOUT, SNAPCTL_INPUT_ERROR, \
 from snapctl.utils.helper import snapctl_error, snapctl_success, get_dot_snapser_dir
 from snapctl.utils.echo import info, warning
 
-
 class Byows:
     """
       CLI commands exposed for a Bring your own Workstation
@@ -70,6 +69,10 @@ class Byows:
                 snapctl_error(
                     message="Missing Input --snapend-id=$your_snapend_id",
                     code=SNAPCTL_INPUT_ERROR)
+            if not Byows.is_valid_cluster_id(self.snapend_id):
+                snapctl_error(
+                    message="Invalid value --snapend-id must be a valid Snapend ID, e.g., 'a1b2c3d4'",
+                    code=SNAPCTL_INPUT_ERROR)
             if self.byosnap_id is None or self.byosnap_id == '':
                 snapctl_error(
                     message="Missing Input --byosnap-id=$your_byosnap_id",
@@ -99,12 +102,11 @@ class Byows:
     def _get_export_commands(snap_ids, port):
         '''
         Generate export commands for the given snap IDs and port.
-        Replace hyphens with underscores in environment variable names.
         '''
         env_vars = []
 
         for snap_id in snap_ids:
-            upper_id = snap_id.upper().replace("-", "_")
+            upper_id = snap_id.upper()
             env_vars.append(f"SNAPEND_{upper_id}_GRPC_URL=localhost:{port}")
             env_vars.append(
                 f"SNAPEND_{upper_id}_HTTP_URL=http://localhost:{port}")
@@ -122,12 +124,11 @@ class Byows:
     def _generate_env_file(snap_ids, port):
         '''
         Generate an environment file with the given snap IDs and port.
-        Replace hyphens with underscores in environment variable names.
         '''
         env_lines = []
 
         for snap_id in snap_ids:
-            upper_id = snap_id.upper().replace("-", "_")
+            upper_id = snap_id.upper()
             env_lines.append(
                 f"export SNAPEND_{upper_id}_GRPC_URL=localhost:{port}")
             env_lines.append(
@@ -392,7 +393,7 @@ class Byows:
                     self._handle_signal))
                 if hasattr(signal, "SIGBREAK"):
                     signal.signal(signal.SIGBREAK,
-                                  functools.partial(self._handle_signal))
+                    functools.partial(self._handle_signal))
                 # Set up port forward
                 self._setup_port_forward(
                     response_json['proxyPrivateKey'],
@@ -411,16 +412,15 @@ class Byows:
                 return snapctl_success(
                     message='complete', progress=progress)
             snapctl_error(
-                message='Unable to setup port forward.',
+                message='Attach failed.',
                 code=SNAPCTL_BYOWS_ATTACH_ERROR, progress=progress)
         except HTTPError as http_err:
             snapctl_error(
-                message=Byows._format_portal_http_error(
-                    "Unable to setup port forward", http_err, res),
+                message=Byows._format_portal_http_error("Attach failed.", http_err, res),
                 code=SNAPCTL_BYOWS_ATTACH_ERROR, progress=progress)
         except RequestException as e:
             snapctl_error(
-                message=f"Exception: Unable to setup port forward {e}",
+                message=f"Attach failed: {e}",
                 code=SNAPCTL_BYOWS_ATTACH_ERROR, progress=progress)
         finally:
             progress.stop()
@@ -465,3 +465,21 @@ class Byows:
                 code=SNAPCTL_BYOWS_RESET_ERROR, progress=progress)
         finally:
             progress.stop()
+
+    @staticmethod
+    def is_valid_cluster_id(cluster_id: str) -> bool:
+        """
+        Check if the input is a valid cluster ID (Snapend ID).
+        """
+        import re
+        if not cluster_id:
+            return False
+
+        pattern = "^[a-z0-9]+$"
+        if not re.match(pattern, cluster_id):
+            return False
+
+        if len(cluster_id) != 8:
+            return False
+
+        return True

snapctl/commands/release_notes.py

@@ -35,9 +35,15 @@ class ReleaseNotes:
         """
         print('== Releases ' + '=' * (92))
         # List all resource files in snapctl.data.releases
+        final_list = []
         for resource in pkg_resources.contents(snapctl.data.releases):
             if resource.endswith('.mdx'):
-                print(resource.replace('.mdx', '').replace('.md', ''))
+                final_list.append(resource.replace(
+                    '.mdx', '').replace('.md', ''))
+        # Sort versions in descending order
+        final_list.sort(reverse=True)
+        for version in final_list:
+            print(f"- {version}")
         print('=' * (104))
         snapctl_success(message="List versions")
 

snapctl/commands/snapend.py

@@ -22,7 +22,7 @@ from snapctl.config.constants import SERVER_CALL_TIMEOUT, SNAPCTL_INPUT_ERROR, \
     SNAPCTL_SNAPEND_APPLY_MANIFEST_MISMATCH_ERROR
 from snapctl.config.hashes import PROTOS_TYPES, CLIENT_SDK_TYPES, SERVER_SDK_TYPES, \
     SNAPEND_MANIFEST_TYPES, SDK_TYPES, SDK_ACCESS_AUTH_TYPE_LOOKUP
-from snapctl.utils.echo import error, success, info, warning
+from snapctl.utils.echo import error, success, info
 from snapctl.utils.helper import snapctl_error, snapctl_success
 
 
@@ -85,20 +85,16 @@ class Snapend:
         self.force: bool = force
         self.category: str = category
         self.category_format: str = category_format
+        self.portal_category: Union[str, None] = Snapend._make_portal_category(
+            category, category_format)
         self.category_type: Union[str, None] = category_type
         self.category_http_lib: Union[str, None] = category_http_lib
-        self.out_path: Union[str, None] = out_path
-        self.snaps: Union[str, None] = snaps
-        self.blocking: bool = blocking
-        # Values below are derived values
-        # portal_category: This is purely because we have simplified the input for the user
-        # Only used for a reverse lookup to pass the category to the portal server
-        self.portal_category: Union[str, None] = Snapend._make_portal_category(
-            category_format)
-        # download_types: This stores our own internal mapping of the category to the type
         self.download_types: Union[
             Dict[str, Dict[str, str]], None
         ] = Snapend._make_download_type(category)
+        self.out_path: Union[str, None] = out_path
+        self.snaps: Union[str, None] = snaps
+        # Values below are derived values
         self.manifest_file_name: Union[str, None] = Snapend._get_manifest_file_name(
             manifest_path_filename
         )
@@ -106,6 +102,7 @@ class Snapend:
             byosnaps) if byosnaps else None
         self.byogs_list: Union[str, None] = Snapend._make_byogs_list(
             byogs) if byogs else None
+        self.blocking: bool = blocking
         # Validate input
         self.validate_input()
 
@@ -120,19 +117,19 @@ class Snapend:
         return None
 
     @staticmethod
-    def _make_portal_category(category_format: str):
+    def _make_portal_category(category: str, category_format: str):
         '''
             We have simplified the input for the user to only take the category as sdk
             The portal server however expects us to pass client-sdk or server-sdk
             Hence we need to do this
         '''
-        if category_format in CLIENT_SDK_TYPES:
+        if category == 'sdk' and category_format in CLIENT_SDK_TYPES:
             return 'client-sdk'
-        if category_format in SERVER_SDK_TYPES:
+        if category == 'sdk' and category_format in SERVER_SDK_TYPES:
             return 'server-sdk'
-        if category_format in PROTOS_TYPES:
+        if category == 'protos' and category_format in PROTOS_TYPES:
             return 'protos'
-        if category_format in SNAPEND_MANIFEST_TYPES:
+        if category == 'snapend-manifest' and category_format in SNAPEND_MANIFEST_TYPES:
             return 'snapend-manifest'
         return None
 
@@ -247,8 +244,6 @@ class Snapend:
             # Customize snaps
             if self.snaps:
                 url += f"&snaps={self.snaps}"
-            if "None" in url:
-                warning('Detecting a potential issue in the download URL.')
             res = requests.get(
                 url, headers={'api-key': self.api_key}, timeout=SERVER_CALL_TIMEOUT
             )
@@ -400,14 +395,8 @@ class Snapend:
                     code=SNAPCTL_INPUT_ERROR)
             if self.category not in Snapend.DOWNLOAD_TYPE_NOT_REQUIRED and \
                (self.download_types is None or self.category_format not in self.download_types):
-                message = "Invalid format. Valid formats are " + \
-                    "(req: --category sdk|protos|snapend-manifest --format  " + \
-                    "sdk(" + ", ".join(SDK_TYPES.keys()) + \
-                    ") | protos(" + ", ".join(PROTOS_TYPES.keys()) + ")" + \
-                    ") | snapend-manifest(" + \
-                    ", ".join(SNAPEND_MANIFEST_TYPES.keys()) + ")"
                 snapctl_error(
-                    message=message, code=SNAPCTL_INPUT_ERROR)
+                    message="Invalid Download format.", code=SNAPCTL_INPUT_ERROR)
             # Check the Protos category
             if self.category == 'protos' and self.category_type not in Snapend.CATEGORY_TYPE_PROTOS:
                 snapctl_error(

snapctl/config/app.py

@@ -0,0 +1,31 @@
+'''
+Configuration by environment
+'''
+from typing import Dict
+
+APP_CONFIG: Dict[str, Dict[str, str]] = {
+    'DEV': {
+        'AMPLITUDE_REGION': 'US',
+        'AMPLITUDE_API_KEY': 'ca863e91bfb3ce084e022920083f2898',
+        'TELEMETRY_ACTIVE': 'false',
+        'TELEMETRY_DRY_RUN': 'true',
+    },
+    'DEV_TWO': {
+        'AMPLITUDE_REGION': 'US',
+        'AMPLITUDE_API_KEY': 'ca863e91bfb3ce084e022920083f2898',
+        'TELEMETRY_ACTIVE': 'false',
+        'TELEMETRY_DRY_RUN': 'true',
+    },
+    'PLAYTEST': {
+        'AMPLITUDE_REGION': 'US',
+        'AMPLITUDE_API_KEY': 'ca863e91bfb3ce084e022920083f2898',
+        'TELEMETRY_ACTIVE': 'false',
+        'TELEMETRY_DRY_RUN': 'false',
+    },
+    'PROD': {
+        'AMPLITUDE_REGION': 'US',
+        'AMPLITUDE_API_KEY': '31fe2221f24fc30694cda777e98bd7a1',
+        'TELEMETRY_ACTIVE': 'false',
+        'TELEMETRY_DRY_RUN': 'false',
+    }
+}

snapctl/config/constants.py

@@ -2,8 +2,8 @@
 Constants used by snapctl
 """
 COMPANY_NAME = 'Snapser'
-VERSION_PREFIX = 'beta-'
-VERSION = '0.49.5'
+VERSION_PREFIX = ''
+VERSION = '0.53.1'
 CONFIG_FILE_MAC = '~/.snapser/config'
 CONFIG_FILE_WIN = '%homepath%\\.snapser\\config'
 
@@ -13,6 +13,10 @@ URL_KEY = 'SNAPSER_URL_KEY'
 CONFIG_PATH_KEY = 'SNAPSER_CONFIG_PATH'
 SERVER_CALL_TIMEOUT = 300
 
+# Telemetry
+AMPLITUDE_HTTP_US = "https://api2.amplitude.com/2/httpapi"
+AMPLITUDE_HTTP_EU = "https://api.eu.amplitude.com/2/httpapi"
+
 # HTTP codes
 HTTP_UNAUTHORIZED = 401
 HTTP_FORBIDDEN = 403

snapctl/data/releases/beta-0.50.0.mdx

@@ -0,0 +1,10 @@
+## beta-0.50.0
+##### June 5, 2025
+
+### Bug fix
+- Success, info or warning messages were sometimes getting truncated in the CLI output. This has been fixed.
+- Snapctl byosnap and byogs now support features that could only work with Buildkit.
+
+### Feature
+- The `snapctl byosnap upload-docs` command now supports `--version` to keep it consistent with all the new commands like `sync` and `publish`.
+

snapctl/data/releases/beta-0.51.0.mdx

@@ -0,0 +1,6 @@
+## beta-0.51.0
+#### Jun 5, 2025
+
+### Improvements
+#### BYOWS
+- Improved snapend ID validation

snapctl/data/releases/beta-0.53.1.mdx

@@ -0,0 +1,6 @@
+## beta-0.53.1
+#### Aug 27, 2025
+
+### Bug fix
+#### Snapend Download
+- Fixed a bug that was preventing download of manifests and protos for a Snapend.

snapctl/main.py

@@ -3,7 +3,6 @@
 """
 import configparser
 import os
-import json
 from sys import platform
 from typing import Union
 import typer
@@ -24,6 +23,7 @@ from snapctl.config.hashes import PROTOS_TYPES, SERVICE_IDS, \
     SNAPEND_MANIFEST_TYPES, SDK_TYPES
 from snapctl.utils.echo import error, success, info
 from snapctl.utils.helper import validate_api_key
+from snapctl.utils.telemetry import telemetry
 
 ######### Globals #########
 
@@ -91,6 +91,21 @@ def extract_config(extract_key: str, profile: Union[str, None] = None) -> object
     return result
 
 
+def get_environment(api_key_value: Union[str, None]) -> str:
+    """
+        Returns the environment based on the api_key
+    """
+    if api_key_value is None:
+        return 'UNKNOWN'
+    if api_key_value.startswith('dev_'):
+        return 'DEV'
+    if api_key_value.startswith('devtwo_'):
+        return 'DEV_TWO'
+    if api_key_value.startswith('playtest_'):
+        return 'PLAYTEST'
+    return 'PROD'
+
+
 def get_base_url(api_key: Union[str, None]) -> str:
     """
         Returns the base url based on the api_key
@@ -154,6 +169,7 @@ def default_context_callback(ctx: typer.Context):
     ctx.obj['api_key'] = api_key_obj['value']
     ctx.obj['api_key_location'] = api_key_obj['location']
     ctx.obj['profile'] = DEFAULT_PROFILE
+    ctx.obj['environment'] = get_environment(api_key_obj['value'])
     ctx.obj['base_url'] = get_base_url(api_key_obj['value'])
     ctx.obj['base_snapend_url'] = get_base_snapend_url(api_key_obj['value'])
 
@@ -174,6 +190,7 @@ def api_key_context_callback(
     ctx.obj['version'] = VERSION
     ctx.obj['api_key'] = api_key
     ctx.obj['api_key_location'] = 'command-line-argument'
+    ctx.obj['environment'] = get_environment(api_key)
     ctx.obj['base_url'] = get_base_url(api_key)
 
 
@@ -206,6 +223,7 @@ def profile_context_callback(
     ctx.obj['api_key'] = api_key_obj['value']
     ctx.obj['api_key_location'] = api_key_obj['location']
     ctx.obj['profile'] = profile if profile else DEFAULT_PROFILE
+    ctx.obj['environment'] = get_environment(api_key_obj['value'])
     ctx.obj['base_url'] = get_base_url(api_key_obj['value'])
 
 
@@ -237,6 +255,7 @@ def common(
 
 
 @app.command()
+@telemetry("validate", subcommand_arg="subcommand")
 def validate(
     ctx: typer.Context,
     api_key: Union[str, None] = typer.Option(
@@ -256,6 +275,7 @@ def validate(
 
 
 @app.command()
+@telemetry("release_notes", subcommand_arg="subcommand")
 def release_notes(
     ctx: typer.Context,
     subcommand: str = typer.Argument(
@@ -284,6 +304,7 @@ def release_notes(
 
 
 @app.command()
+@telemetry("byogs", subcommand_arg="subcommand")
 def byogs(
     ctx: typer.Context,
     # Required fields
@@ -353,6 +374,7 @@ def byogs(
 
 
 @app.command()
+@telemetry("byosnap", subcommand_arg="subcommand")
 def byosnap(
     ctx: typer.Context,
     # Required fields
@@ -403,7 +425,7 @@ def byosnap(
         help="(req: create) Language of your snap - " +
         ", ".join(ByoSnap.LANGUAGES) + "."
     ),
-    # publish-image, publish-version, publish, sync
+    # publish-image, publish-version, publish, sync, upload-docs
     tag: str = typer.Option(
         None, "--tag", help=(
             "(req: publish-image, publish-version, upload-docs) (optional: publish, sync) Tag for your snap"
@@ -461,6 +483,7 @@ def byosnap(
 
 
 @app.command()
+@telemetry("game", subcommand_arg="subcommand")
 def game(
     ctx: typer.Context,
     # Required fields
@@ -496,6 +519,7 @@ def game(
 
 
 @app.command()
+@telemetry("generate", subcommand_arg="subcommand")
 def generate(
     ctx: typer.Context,
     # Required fields
@@ -542,6 +566,7 @@ def generate(
 
 
 @app.command()
+@telemetry("snapend", subcommand_arg="subcommand")
 def snapend(
     ctx: typer.Context,
     # Required fields
@@ -685,6 +710,7 @@ def snapend(
 
 
 @app.command()
+@telemetry("byows", subcommand_arg="subcommand")
 def byows(
     ctx: typer.Context,
     # Required fields

snapctl/utils/echo.py

@@ -4,38 +4,49 @@ This module contains functions to print messages to the console.
 import json
 import typer
 from rich import print
+from rich.markup import escape
 from snapctl.config.constants import SNAPCTL_ERROR
 from snapctl.types.definitions import ErrorResponse
 # Run `python -m rich.emoji` to get a list of all emojis that are supported
 
 
-def error(msg: str, code: int = SNAPCTL_ERROR, data: object = None) -> None:
+def _stringify_message(msg: object) -> str:
+    if isinstance(msg, (dict, list)):
+        return json.dumps(msg, indent=2)
+    return str(msg)
+
+
+def error(msg: object, code: int = SNAPCTL_ERROR, data: object = None) -> None:
     """
     Prints an error message to the console.
     """
+    msg = _stringify_message(msg)
     error_response = ErrorResponse(
         error=True, code=code, msg=msg, data=data if data else ''
     )
-    print(f"[bold red]Error[/bold red] {msg}")
+    print(f"[bold red]Error[/bold red] {escape(msg)}")
     typer.echo(json.dumps(error_response.to_dict()), err=True)
 
 
-def warning(msg: str) -> None:
+def warning(msg: object) -> None:
     """
     Prints a warning message to the console.
     """
-    print(f"[bold yellow]Warning[/bold yellow] {msg}")
+    msg = _stringify_message(msg)
+    print(f"[bold yellow]Warning[/bold yellow] {escape(msg)}")
 
 
-def info(msg: str) -> None:
+def info(msg: object) -> None:
     """
     Prints an info message to the console.
     """
-    print(f"[bold blue]Info[/bold blue] {msg}")
+    msg = _stringify_message(msg)
+    print(f"[bold blue]Info[/bold blue] {escape(msg)}")
 
 
-def success(msg: str) -> None:
+def success(msg: object) -> None:
     """
     Prints a success message to the console.
     """
-    print(f"[bold green]Success[/bold green] {msg}")
+    msg = _stringify_message(msg)
+    print(f"[bold green]Success[/bold green] {escape(msg)}")

snapctl/utils/helper.py

@@ -2,6 +2,7 @@
 Helper functions for snapctl
 """
 from typing import Union, Dict
+from pathlib import Path
 import re
 import platform
 import os
@@ -14,7 +15,7 @@ from snapctl.config.constants import HTTP_NOT_FOUND, HTTP_FORBIDDEN, HTTP_UNAUTH
     SERVER_CALL_TIMEOUT, SNAPCTL_CONFIGURATION_ERROR, SNAPCTL_SUCCESS
 from snapctl.config.hashes import ARCHITECTURE_MAPPING
 from snapctl.utils.echo import error, success
-from pathlib import Path
+from snapctl.config.app import APP_CONFIG
 
 
 def validate_api_key(base_url: str, api_key: Union[str, None]) -> bool:
@@ -185,10 +186,20 @@ def check_use_containerd_snapshotter() -> bool:
     except Exception:
         return False
 
+
 def get_dot_snapser_dir() -> Path:
     """
     Returns the .snapser configuration directory, creating it if necessary.
     """
     config_dir = Path.home() / ".snapser"
     config_dir.mkdir(parents=True, exist_ok=True)
-    return config_dir
+    return config_dir
+
+
+def get_config_value(environment: str, key: str) -> str:
+    """
+    Returns the config value based on the environment.
+    """
+    if environment == '' or environment not in APP_CONFIG or key not in APP_CONFIG[environment]:
+        return ''
+    return APP_CONFIG[environment][key]

snapctl/utils/telemetry.py

@@ -0,0 +1,160 @@
+'''
+Telemetry utilities for snapctl
+'''
+from __future__ import annotations
+from typing import Any, Dict, Optional
+import functools
+import platform
+import uuid
+import hashlib
+import requests
+import typer
+from snapctl.config.constants import AMPLITUDE_HTTP_US, AMPLITUDE_HTTP_EU
+from snapctl.utils.helper import get_config_value
+from snapctl.utils.echo import info
+
+
+def _ctx(ctx: Optional[typer.Context]) -> dict:
+    try:
+        return ctx.obj or {}
+    except Exception:
+        return {}
+
+
+def _base_props(ctx: Optional[typer.Context]) -> Dict[str, Any]:
+    c = _ctx(ctx)
+    return {
+        "source": "snapctl",
+        "cli_version": c.get("version"),
+        "os": platform.system(),
+    }
+
+
+def _device_id_from_ctx(ctx: Optional[typer.Context]) -> str:
+    """
+    Amplitude requires either user_id or device_id.
+    We derive a non-reversible device_id from the API key (if present).
+    """
+    c = _ctx(ctx)
+    api_key = c.get("api_key") or ""
+    if api_key:
+        # hash + truncate to keep it compact but stable
+        h = hashlib.sha256(f"snapctl|{api_key}".encode("utf-8")).hexdigest()
+        return f"dev-{h[:32]}"
+    # fallback: hostname or a random-ish node id
+    return f"host-{platform.node() or uuid.getnode()}"
+
+
+def _endpoint_from_env(ctx: Optional[typer.Context]) -> str:
+    """
+    Returns the Amplitude endpoint based on environment config.
+    """
+    c = _ctx(ctx)
+    env = c.get("environment")
+    region = (get_config_value(env, "AMPLITUDE_REGION") or "US").upper()
+    return AMPLITUDE_HTTP_EU if region == "EU" else AMPLITUDE_HTTP_US
+
+
+def _is_active(ctx: Optional[typer.Context]) -> tuple[bool, bool, Optional[str]]:
+    """
+    Returns (telemetry_active, dry_run, api_key)
+    """
+    c = _ctx(ctx)
+    env = c.get("environment")
+    api_key = get_config_value(env, "AMPLITUDE_API_KEY")
+    if not api_key or api_key == '':
+        return (False, False, None)
+    telemetry_active = get_config_value(env, "TELEMETRY_ACTIVE") == "true"
+    dry_run = get_config_value(env, "TELEMETRY_DRY_RUN") == "true"
+    return (telemetry_active, dry_run, api_key)
+
+
+def _post_event(payload: dict, endpoint: str, timeout_s: float) -> None:
+    """
+    Post the event to Amplitude.
+    """
+    try:
+        requests.post(endpoint, json=payload, timeout=timeout_s)
+    except Exception:
+        # Never break the CLI
+        pass
+
+
+def track_simple(
+    ctx: Optional[typer.Context],
+    *,
+    command: str,
+    sub: str,
+    result: str,
+    count: int = 1,
+    timeout_s: float = 2.0,
+) -> None:
+    """
+    Minimal Amplitude event:
+      event_type = action
+      event_properties = { category, label, count, ...tiny base props }
+    """
+    category = 'cli'
+    active, dry_run, api_key = _is_active(ctx)
+    if not active or not api_key:
+        return
+
+    action = f"{command}_{sub}" if sub else command
+    props = {**_base_props(ctx)}
+    if dry_run:
+        info(
+            f"[telemetry:DRY-RUN] category={category} action={action} label={result} "
+            f"count={count} props={props}")
+        return
+
+    payload = {
+        "api_key": api_key,
+        "events": [{
+            "event_type": action,
+            "device_id": _device_id_from_ctx(ctx),
+            "event_properties": props,
+        }]
+    }
+    _post_event(payload, _endpoint_from_env(ctx), timeout_s)
+
+# -------- Decorator to auto-track per-command result --------
+
+
+def telemetry(command_name: str, subcommand_arg: Optional[str] = None):
+    """
+    Decorator to track telemetry for a command function.
+    """
+    def deco(fn):
+        @functools.wraps(fn)
+        def wrapper(*args, **kwargs):
+            ctx: Optional[typer.Context] = kwargs.get("ctx")
+            sub = (kwargs.get(subcommand_arg) if subcommand_arg else None)
+            label = "success"  # default unless we see a failure
+            should_track_run = True
+            try:
+                result = fn(*args, **kwargs)
+                return result
+            except typer.Exit as e:
+                code = getattr(e, "exit_code", None)
+                # treat Exit(0/None) as success, anything else as failure
+                label = "success" if (code == 0 or code is None) else "failure"
+                # Now we only want to track if it was a success
+                #   typer.Exit is called by us on user failure.
+                #   If we start tracking this, bad actors can spam our telemetry.
+                should_track_run = not label == 'failure'
+                raise
+            except SystemExit as e:
+                # print('#1')
+                code = getattr(e, "code", None)
+                label = "success" if (code == 0 or code is None) else "failure"
+                raise
+            except Exception:
+                # print('#2')
+                label = "failure"
+                raise
+            finally:
+                if should_track_run:
+                    track_simple(ctx, command=command_name,
+                                 sub=sub, result=label, count=1)
+        return wrapper
+    return deco

{snapctl-0.49.5.dist-info → snapctl-0.53.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: snapctl
-Version: 0.49.5
+Version: 0.53.1
 Summary: Snapser CLI Tool
 Author: Ajinkya Apte
 Author-email: aj@snapser.com

{snapctl-0.49.5.dist-info → snapctl-0.53.1.dist-info}/RECORD

@@ -1,15 +1,16 @@
 snapctl/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 snapctl/__main__.py,sha256=43jKoTk8b85hk_MT6499N3ruHdEfM8WBImd_-3VzjI8,116
 snapctl/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-snapctl/commands/byogs.py,sha256=WumLZRriCVF0SSnMn8TUL--iWhh3Yub3yQ-jz30faI0,19486
-snapctl/commands/byosnap.py,sha256=9Xe75VAi-KPFALSleUyMJsrvDJEG6cxBiGiF267PSJA,76897
-snapctl/commands/byows.py,sha256=xmvTsWGjp3CkIvMj3LdVJO02P5W0-HfWqsP2pf9tsXE,18519
+snapctl/commands/byogs.py,sha256=fwXM7X_IqkVPAByGWWxwNzJeZlDTsh_ApWNH3IhyVVM,20076
+snapctl/commands/byosnap.py,sha256=TAITdbB_FhGk7K94bPDDjykXbU9XwO9opW__qdeg0SQ,78187
+snapctl/commands/byows.py,sha256=wbfCGbjigZo37mryvvE_VJ9bJWjIjcRBLAS7IT6VNrI,18906
 snapctl/commands/game.py,sha256=lAABIWIibrwcqvpKvTy_7UzzLtbiP6gdk4_qPBHFKOI,5248
 snapctl/commands/generate.py,sha256=9-NlZVQllBT2LZT_t9S3ztwtHzTbM-C8_x0f6z70U3g,5606
-snapctl/commands/release_notes.py,sha256=QlhBlywLiRTKBs3SlaxHf-0E0OEU_47Xjld9gGtj4Zw,1943
-snapctl/commands/snapend.py,sha256=lcg9HlgQ9YedP-GmNEZQz8UeIPmfa49KtLRgeeHyaCo,40310
+snapctl/commands/release_notes.py,sha256=EMl-NK9-MSdRxiVyA0MLX4CBG0zijOctddEODQa5PZ4,2151
+snapctl/commands/snapend.py,sha256=-Z4GjVvJ39H9XCCTx6SUlAUWOwam5Nc0V6JdbR2IY4c,39675
 snapctl/config/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-snapctl/config/constants.py,sha256=9A7Ktr2fZ4O8ugnLMKUnMV01znnrKlfXGlJU4SOpy3Q,3716
+snapctl/config/app.py,sha256=QXSy10Yrw9yhV7VlAwxxdUCRrphoP9-2-sEaaL2SZa4,889
+snapctl/config/constants.py,sha256=UOVdr_aCoGeQhOWtZIge8k1OWWh8KZ5pfCOzcBj0eS8,3844
 snapctl/config/endpoints.py,sha256=jD0n5ocJBbIkrb97F2_r9hqAHzUuddAqzqqBAPUKDTI,477
 snapctl/config/hashes.py,sha256=3OKAyOxQPnn--_hvPIzFJnhC8NVfQK4WT-RH4PHEV1w,5242
 snapctl/data/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -28,16 +29,18 @@ snapctl/data/releases/beta-0.49.0.mdx,sha256=pqJP7NfM3ZMxs4SoeANCdDqTxjR9IBGbBI3
 snapctl/data/releases/beta-0.49.1.mdx,sha256=4EXupEegYffnL5bu_XWxGbzIPp9xOzl7t4xbmhq52fU,200
 snapctl/data/releases/beta-0.49.2.mdx,sha256=Vv_OIQyPieEGI9FgTUT0v5Gm0PC2JWa2FqcCUhnvx6s,176
 snapctl/data/releases/beta-0.49.3.mdx,sha256=XmSfpiH-LqvKS2REJ5FGDcLgyEN-OcSzwrXNI_EhiGc,234
-snapctl/data/releases/beta-0.49.4.mdx,sha256=olSEvzwrBgp6TfVYehYslhGrjLXz1EcybTmbXUmtA18,161
-snapctl/data/releases/beta-0.49.5.mdx,sha256=I_NdMkfxtFUOhUQgCUfcnY1YraFim4eAtRYq5g0dJqs,138
-snapctl/main.py,sha256=6EDEQlcF3GPSqH3-Ezl7bkI33ZKaFR_c55B0Dkt0pDM,25212
+snapctl/data/releases/beta-0.50.0.mdx,sha256=_w9f1HjHqukQ8IaTfUdk2W3gBcSwjMyMA8-rjuUxYTo,399
+snapctl/data/releases/beta-0.51.0.mdx,sha256=5_xY29NJtH3Qa92UycCudrwDkSlUHRVNnP4GE4hF7-Y,93
+snapctl/data/releases/beta-0.53.1.mdx,sha256=b__2LPkDhU3cTw5UC19Hxv1rDz6BsSLeI6fhHjOCP08,149
+snapctl/main.py,sha256=BdVjXyCX64d3JIhPjDo4QEGhos6RAcQqSdY3MHBQNc4,26264
 snapctl/types/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 snapctl/types/definitions.py,sha256=EQzLeiXkJ8ISRlCqHMviNVsWWpmhWjpKaOBLdlvOTmY,644
 snapctl/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-snapctl/utils/echo.py,sha256=V0qgjqqGXRiueMkq31enmNmdqciC8S90qGRcK8UupXA,1090
-snapctl/utils/helper.py,sha256=7ugGs1GE7Rywf1-tQxrgqXUU97EQYFjS3JUDpk9SX_Q,6850
-snapctl-0.49.5.dist-info/LICENSE,sha256=6AcXm54KFSpmUI1ji9NIBd4Xl-DtjTqiyjBzfVb_CEk,2804
-snapctl-0.49.5.dist-info/METADATA,sha256=LTqz4qckGzXeP20E2jP_ZtiVxIrNyjoQGA4NKDGMN5Y,36275
-snapctl-0.49.5.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-snapctl-0.49.5.dist-info/entry_points.txt,sha256=tkKW9MzmFdRs6Bgkv29G78i9WEBK4WIOWunPfe3t2Wg,44
-snapctl-0.49.5.dist-info/RECORD,,
+snapctl/utils/echo.py,sha256=9fxrPW9kNJwiJvJBFy9RlAP4qGRcPTOHfQb3pQh3CMg,1446
+snapctl/utils/helper.py,sha256=5c5jfAYD4WsvPpuCLMCz3tPvji28786_pD9TZkRSFIs,7179
+snapctl/utils/telemetry.py,sha256=_VntKXUrKgJoLKCskH0Z5VhthiVo8CP572U0mcZIH4k,5028
+snapctl-0.53.1.dist-info/LICENSE,sha256=6AcXm54KFSpmUI1ji9NIBd4Xl-DtjTqiyjBzfVb_CEk,2804
+snapctl-0.53.1.dist-info/METADATA,sha256=vns-UuApeJGMXSEk12QjrBTaGHacAM6FcukJS3-Nxds,36275
+snapctl-0.53.1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+snapctl-0.53.1.dist-info/entry_points.txt,sha256=tkKW9MzmFdRs6Bgkv29G78i9WEBK4WIOWunPfe3t2Wg,44
+snapctl-0.53.1.dist-info/RECORD,,

snapctl/data/releases/beta-0.49.4.mdx

@@ -1,8 +0,0 @@
-## beta-0.49.4
-##### May 20, 2025
-
-### Bug Fixes
-
-#### Bring your own workstation (BYOW)
-- Environment exports no longer include hyphens in the variable names.
-

snapctl/data/releases/beta-0.49.5.mdx

@@ -1,8 +0,0 @@
-## beta-0.49.5
-##### May 22, 2025
-
-### Bug Fixes
-
-#### Snapend Download
-- Fixed a bug with snapend download manifest and apply manifest.
-