snapctl 1.1.2__py3-none-any.whl → 1.1.3__py3-none-any.whl

snapctl/commands/byosnap.py

@@ -1350,7 +1350,7 @@ class ByoSnap:
         if self.path is not None or self.resources_path is not None:
             self.upload_docs(no_exit=True)
         snapctl_success(
-            message='BYOSNAP publish successful', no_exit=no_exit)
+            message='BYOSNAP publish image successful', no_exit=no_exit)
 
     def publish_version(self, no_exit: bool = False) -> None:
         """

snapctl/config/constants.py

@@ -3,13 +3,14 @@ Constants used by snapctl
 """
 COMPANY_NAME = 'Snapser'
 VERSION_PREFIX = ''
-VERSION = '1.1.2'
+VERSION = '1.1.3'
 CONFIG_FILE_MAC = '~/.snapser/config'
 CONFIG_FILE_WIN = '%homepath%\\.snapser\\config'
 
 DEFAULT_PROFILE = 'default'
 API_KEY = 'SNAPSER_API_KEY'
 URL_KEY = 'SNAPSER_URL_KEY'
+TEST_MODE = 'SNAPSER_TEST_MODE'
 CONFIG_PATH_KEY = 'SNAPSER_CONFIG_PATH'
 SERVER_CALL_TIMEOUT = 300
 

snapctl/config/hashes.py

@@ -182,10 +182,11 @@ SNAPEND_MANIFEST_TYPES: Dict[str, Dict[str, str]] = {
 }
 
 SERVICE_IDS: List[str] = [
-    'analytics', 'auth', 'client-logs', 'events', 'experiments', 'gdpr', 'guilds', 'hades', 'iap',
-    'inventory', 'leaderboards', 'matchmaking', 'notifications', 'parties', 'profiles', 'quests',
-    'relay', 'remote-config', 'scheduler', 'sequencer', 'social-graph', 'statistics', 'storage',
-    'trackables', 'xp'
+    'analytics', 'assets', 'auth', 'chat', 'client-logs', 'decorators', 'event-bus', 'experiments',
+    'gdpr', 'game-server-fleets', 'guilds', 'iap', 'inbox', 'inventory', 'kws', 'leaderboards',
+    'events', 'lobbies', 'matchmaking', 'notifications', 'parties', 'photon', 'profiles', 'quago',
+    'quests', 'relay', 'remote-config', 'scheduler', 'sequencer', 'social-graph', 'statistics',
+    'storage', 'trackables'
 ]
 
 SDK_ACCESS_AUTH_TYPE_LOOKUP: Dict[str, Dict[str, str]] = {

snapctl/data/releases/1.1.3.mdx

@@ -0,0 +1,5 @@
+## Release 1.1.3
+##### Oct 17, 2025
+
+### Bug Fixes
+1. Updated help text for various command options to improve clarity and correctness.

snapctl/main.py

@@ -262,10 +262,12 @@ def common(
 def validate(
     ctx: typer.Context,
     api_key: Union[str, None] = typer.Option(
-        None, "--api-key", help="API Key override.", callback=api_key_context_callback
+        None, "--api-key",
+        help="API Key override.", callback=api_key_context_callback
     ),
     profile: Union[str, None] = typer.Option(
-        None, "--profile", help="Profile from the Snapser config to use.", callback=profile_context_callback
+        None, "--profile",
+        help="Profile from the Snapser config to use.", callback=profile_context_callback
     ),
 ) -> None:
     """
@@ -285,13 +287,16 @@ def release_notes(
         ..., help="Release Notes Subcommands: " + ", ".join(ReleaseNotes.SUBCOMMANDS) + "."
     ),
     version: str = typer.Option(
-        VERSION_PREFIX + VERSION, help="(optional: show-version) If not passed will show the latest version."
+        VERSION_PREFIX + VERSION,
+        help="(optional: show-version) If not passed will show the latest version."
     ),
     api_key: Union[str, None] = typer.Option(
-        None, "--api-key", help="API Key override.", callback=api_key_context_callback
+        None, "--api-key",
+        help="API Key override.", callback=api_key_context_callback
     ),
     profile: Union[str, None] = typer.Option(
-        None, "--profile", help="Profile from the Snapser config to use.", callback=profile_context_callback
+        None, "--profile",
+        help="Profile from the Snapser config to use.", callback=profile_context_callback
     ),
 ) -> None:
     """
@@ -316,28 +321,37 @@ def byogs(
     ),
     tag: str = typer.Option(
         None, "--tag",
-        help="(req: build, push, publish) Tag for your snap"
+        help="(required: build, push, publish) Tag for your snap."
     ),
     # publish and publish-image
     path: Union[str, None] = typer.Option(
-        None, "--path", help="(req: build, publish) Path to your snap code"
+        None, "--path",
+        help="(required: build, publish) Path to your snap code."
     ),
     resources_path: Union[str, None] = typer.Option(
-        None, "--resources-path", help="(optional: publish) Path to resources such as your Dockerfile, swagger.json or README.md"
+        None, "--resources-path",
+        help=(
+            "(optional: publish) Path to resources such as your Dockerfile, "
+            "swagger.json or README.md."
+        )
     ),
     docker_filename: str = typer.Option(
-        "Dockerfile", help="(optional: publish) Dockerfile name to use"
+        "Dockerfile", help="(optional: publish) Dockerfile name to use."
     ),
     skip_build: bool = typer.Option(
-        False, "--skip-build", help="(optional: publish) Skip the build step. You have to pass the image tag you used during the build step."
+        False, "--skip-build",
+        help=(
+            "(optional: publish) Skip the build step. You have to pass the image tag you "
+            "used during the build step."
+        )
     ),
     snapend_id: str = typer.Option(
         None, "--snapend-id",
-        help=("(req: sync) Snapend Id.")
+        help=("(required: sync) Snapend Id.")
     ),
     fleet_names: str = typer.Option(
         None, "--fleet-names",
-        help=("(req: sync) Comma separated fleet names.")
+        help=("(required: sync) Comma separated fleet names.")
     ),
     blocking: bool = typer.Option(
         False, "--blocking",
@@ -348,10 +362,12 @@ def byogs(
     ),
     # overrides
     api_key: Union[str, None] = typer.Option(
-        None, "--api-key", help="API Key override.", callback=api_key_context_callback
+        None, "--api-key",
+        help="API Key override.", callback=api_key_context_callback
     ),
     profile: Union[str, None] = typer.Option(
-        None, "--profile", help="Profile from the Snapser config to use.", callback=profile_context_callback
+        None, "--profile",
+        help="Profile from the Snapser config to use.", callback=profile_context_callback
     ),
 ) -> None:
     """
@@ -382,27 +398,45 @@ def byosnap(
     ctx: typer.Context,
     # Required fields
     subcommand: str = typer.Argument(
-        ..., help="BYOSnap Subcommands: " + ", ".join(ByoSnap.SHOW_SUBCOMMANDS) + ". Commands to be deprecated soon: " + ", ".join(ByoSnap.TO_DEPRECATE_SUBCOMMANDS) + "."
+        ...,
+        help=(
+            "BYOSnap Subcommands: " +
+            ", ".join(ByoSnap.SHOW_SUBCOMMANDS) + ". Commands to be deprecated soon: " +
+            ", ".join(ByoSnap.TO_DEPRECATE_SUBCOMMANDS) + "."
+        )
     ),
     byosnap_id: Union[str, None] = typer.Option(
-        None, "--byosnap-id", help="(req: 'publish', 'sync', 'upload-docs', 'create', 'publish-image', 'publish-version', 'update-version') BYOSnap Id. Should start with byosnap-"
+        None, "--byosnap-id",
+        help=(
+            "(required: publish, sync, upload-docs, create, publish-image, publish-version, "
+            "update-version) BYOSnap Id. Should start with `byosnap-`."
+        )
     ),
     # publish
     path: Union[str, None] = typer.Option(
-        None, "--path", help="(req: publish, sync, publish-image, publish-version) Path to your snap code"
+        None, "--path",
+        help="(required: publish, sync, publish-image, publish-version) Path to your snap code."
     ),
     resources_path: Union[str, None] = typer.Option(
-        None, "--resources-path", help="(optional: publish, sync, publish-image, publish-version; req: upload-docs) Path to resources such as your Dockerfile, snapser-byosnap-profile.json, snapser-tool-*.json, swagger.json or README.md"
+        None, "--resources-path",
+        help=(
+            "(required: upload-docs) (optional: publish, sync, publish-image, publish-version) "
+            "Path to resources such as your Dockerfile, snapser-byosnap-profile.json, "
+            "snapser-tool-*.json, swagger.json or README.md."
+        )
     ),
     # publish, sync and publish-version
     version: Union[str, None] = typer.Option(
         None, "--version",
-        help="(req: publish, sync, publish-version) Snap version. Should start with v. Example vX.X.X"
+        help=(
+            "(required: publish, sync, publish-version) Snap semantic version. "
+            "Should start with `v`. Example `vX.X.X`."
+        )
     ),
     # sync
     snapend_id: str = typer.Option(
         None, "--snapend-id",
-        help=("(req: sync) Snapend Id. NOTE: Development Snapends only.")
+        help=("(required: sync) Snapend Id. NOTE: Development Snapends only.")
     ),
     blocking: bool = typer.Option(
         False, "--blocking",
@@ -413,47 +447,64 @@ def byosnap(
     ),
     # create
     name: str = typer.Option(
-        None, "--name", help="(req: create) Name for your snap."
+        None, "--name", help="(required: create) Name for your snap."
     ),
     desc: str = typer.Option(
-        None, "--desc", help="(req: create) Description for your snap"
+        None, "--desc", help="(required: create) Description for your snap."
     ),
     platform_type: str = typer.Option(
         None, "--platform",
-        help="(req: create) Platform for your snap - " +
-        ", ".join(ByoSnap.PLATFORMS) + "."
+        help=(
+            "(required: create) Platform for your snap - " +
+            ", ".join(ByoSnap.PLATFORMS) + "."
+        )
     ),
     language: str = typer.Option(
         None, "--language",
-        help="(req: create) Language of your snap - " +
-        ", ".join(ByoSnap.LANGUAGES) + "."
+        help=(
+            "(required: create) Language of your snap - " +
+            ", ".join(ByoSnap.LANGUAGES) + "."
+        )
     ),
     # 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"
+        None, "--tag",
+        help=(
+            "(required: publish-image, publish-version, upload-docs) (optional: publish, sync) "
+            "Tag for your snap."
         )
     ),
     # overrides
     skip_build: bool = typer.Option(
-        False, "--skip-build", help="(optional: publish-image, publish, sync) Skip the build step. You have to pass the image tag you used during the build step."
+        False, "--skip-build",
+        help=(
+            "(optional: publish-image, publish, sync) Skip the build step. You have to pass "
+            "the image tag you used during the build step."
+        )
     ),
     docker_filename: str = typer.Option(
-        "Dockerfile", help="(optional override: publish, sync) Dockerfile name to use"
+        "Dockerfile", help="(optional: publish, sync) Dockerfile name to use."
     ),
     profile_filename: str = typer.Option(
-        "snapser-byosnap-profile.json", "--profile-filename", help="(req: generate-profile, validate-profile) (optional override: publish, publish-version) BYOSnap Profile is picked up via the --path or the --resources-path. This allows you to override the default profile filename."
+        "snapser-byosnap-profile.json", "--profile-filename",
+        help=(
+            "(required: generate-profile, validate-profile) (optional override: publish, "
+            "publish-version) BYOSnap Profile is picked up via the --path or the "
+            "--resources-path. This allows you to override the default profile filename."
+        )
     ),
     out_path: Union[str, None] = typer.Option(
         None, "--out-path", help=(
-            "(req: generate-profile) Path to output the byosnap profile"
+            "(required: generate-profile) Path to output the byosnap profile."
         )
     ),
     api_key: Union[str, None] = typer.Option(
-        None, "--api-key", help="(optional override) API Key override.", callback=api_key_context_callback
+        None, "--api-key",
+        help="API Key override.", callback=api_key_context_callback
     ),
     profile: Union[str, None] = typer.Option(
-        None, "--profile", help="(optional override) Profile from the Snapser config to use.", callback=profile_context_callback
+        None, "--profile",
+        help="Profile from the Snapser config to use.", callback=profile_context_callback
     ),
 ) -> None:
     """
@@ -496,14 +547,16 @@ def game(
     # name
     name: str = typer.Option(
         None, "--name",
-        help=("(req: create) Name of your game: ")
+        help=("(required: create) Name of your game.")
     ),
     # overrides
     api_key: Union[str, None] = typer.Option(
-        None, "--api-key", help="API Key override.", callback=api_key_context_callback
+        None, "--api-key",
+        help="API Key override.", callback=api_key_context_callback
     ),
     profile: Union[str, None] = typer.Option(
-        None, "--profile", help="Profile from the Snapser config to use.", callback=profile_context_callback
+        None, "--profile",
+        help="Profile from the Snapser config to use.", callback=profile_context_callback
     ),
 ) -> None:
     """
@@ -534,14 +587,16 @@ def application(
     # name
     name: str = typer.Option(
         None, "--name",
-        help=("(req: create) Name of your application: ")
+        help=("(required: create) Name of your application.")
     ),
     # overrides
     api_key: Union[str, None] = typer.Option(
-        None, "--api-key", help="API Key override.", callback=api_key_context_callback
+        None, "--api-key",
+        help="API Key override.", callback=api_key_context_callback
     ),
     profile: Union[str, None] = typer.Option(
-        None, "--profile", help="Profile from the Snapser config to use.", callback=profile_context_callback
+        None, "--profile",
+        help="Profile from the Snapser config to use.", callback=profile_context_callback
     ),
 ) -> None:
     """
@@ -573,21 +628,24 @@ def generate(
     category: Union[str, None] = typer.Option(
         None, "--category",
         help=(
-            "(req: token) (token: " +
-              ", ".join(Generate.CATEGORIES['credentials']) + ')'
+            "(required: token) Supported category - " +
+              ", ".join(Generate.CATEGORIES['credentials']) + "."
         )
     ),
     out_path: Union[str, None] = typer.Option(
-        None, "--out-path", help=(
-            "(req: token) Path to output the byosnap profile"
+        None, "--out-path",
+        help=(
+            "(required: token) Path to output the byosnap profile."
         )
     ),
     # overrides
     api_key: Union[str, None] = typer.Option(
-        None, "--api-key", help="API Key override.", callback=api_key_context_callback
+        None, "--api-key",
+        help="API Key override.", callback=api_key_context_callback
     ),
     profile: Union[str, None] = typer.Option(
-        None, "--profile", help="Profile from the Snapser config to use.", callback=profile_context_callback
+        None, "--profile",
+        help="Profile from the Snapser config to use.", callback=profile_context_callback
     ),
 ) -> None:
     """
@@ -614,96 +672,105 @@ def snapend(
     subcommand: str = typer.Argument(
         ..., help="Snapend Subcommands: " + ", ".join(Snapend.SUBCOMMANDS) + "."
     ),
-    # snapend_id: str = typer.Argument(..., help="Snapend Id"),
     snapend_id: str = typer.Option(
         None, "--snapend-id",
-        help=("(req: state, update, download) Snapend Id")
+        help=("(required: state, update, download) Snapend Id.")
     ),
     # enumerate
     game_id: str = typer.Option(
         None, "--game-id",
-        help="(DEPRECATED: Use --application-id instead) Game Id"
+        help="(DEPRECATED: Use --application-id instead) Game Id."
     ),
     application_id: str = typer.Option(
         None, "--application-id",
-        help="(req: enumerate, create, clone) Application Id"
+        help="(required: enumerate, create, clone) Application Id."
     ),
     # apply, clone
     manifest_path_filename: str = typer.Option(
         None, "--manifest-path-filename",
-        help="(req: create|apply|clone) Full Path to the manifest file including the filename."
+        help=(
+            "(required: create, apply, clone) Full Path to the manifest file "
+            "including the filename."
+        )
     ),
     force: bool = typer.Option(
         False, "--force",
-        help="(optional: apply) If true, Snapser will ignore the configuration diff validation and allow to force apply the manifest."
+        help=(
+            "(optional: apply) If true, Snapser will ignore the configuration diff validation "
+            "and allow to force apply the manifest."
+        )
     ),
     # download
     category: str = typer.Option(
         None, "--category",
         help=(
-            "(req: download) Category of the Download: " +
+            "(required: download) Supported Download Categories - " +
             ", ".join(Snapend.DOWNLOAD_CATEGORY) + "."
         )
     ),
     category_format: str = typer.Option(
         None, "--format",
         help=(
-            "(req: --category sdk|protos|snapend-manifest --format  "
+            "(required: --category sdk|protos|snapend-manifest --format  " +
             "sdk(" + ", ".join(SDK_TYPES.keys()) +
             ") | protos(" + ", ".join(PROTOS_TYPES.keys()) + ")" +
             ") | snapend-manifest(" +
-            ", ".join(SNAPEND_MANIFEST_TYPES.keys()) + ")"
+            ", ".join(SNAPEND_MANIFEST_TYPES.keys()) + ")."
         )
     ),
     category_type: str = typer.Option(
         None, "--type",
         help=(
-            "(optional: download) Only applicable for --category sdk|protos --type "
-            "sdk(" + ", ".join(Snapend.CATEGORY_TYPE_SDK) + ")"
-            " | protos(" + ", ".join(Snapend.CATEGORY_TYPE_PROTOS) + ")"
+            "(optional: download) Only applicable for --category sdk|protos --type " +
+            "sdk(" + ", ".join(Snapend.CATEGORY_TYPE_SDK) + ")" +
+            " | protos(" + ", ".join(Snapend.CATEGORY_TYPE_PROTOS) + ")."
         )
     ),
     category_http_lib: str = typer.Option(
         None, "--http-lib",
         help=(
-            "(optional: download) Only applicable for --category sdk "
+            "(optional: download) Only applicable for --category sdk " +
             "--format " + '|'.join(Snapend.get_formats_supporting_http_lib()) + ' ' +
-            "--type user|server|internal|app "
-            "--http-lib " + Snapend.get_http_formats_str()
+            "--type user|server|internal|app " +
+            "--http-lib " + Snapend.get_http_formats_str() + "."
         )
     ),
     snaps_list_str: Union[str, None] = typer.Option(
         None, "--snaps",
         help=(
-            "(optional: download) Comma separated list of snap ids to customize the "
-              "SDKs, protos or admin settings. "
-              "snaps(" + ", ".join(SERVICE_IDS)
+            "(optional: download) Comma separated list of snap ids to customize the " +
+              "SDKs, protos or admin settings. " +
+              "snaps(" + ", ".join(SERVICE_IDS) + ")."
         )
     ),
     # Clone
     name: Union[str, None] = typer.Option(
-        None, "--name", help="(req: clone, optional: create) Snapend name"),
+        None, "--name",
+        help="(required: clone, optional: create) Snapend name."),
     env: Union[str, None] = typer.Option(
-        None, "--env", help=(
-            "(req: clone, optional: create) Snapend environment"
-            "Environments: (" + ", ".join(Snapend.ENV_TYPES) + ")"
+        None, "--env",
+        help=(
+            "(required: clone, optional: create) Snapend environments " +
+            " - " + ", ".join(Snapend.ENV_TYPES) + "."
         )),
     # Download, Apply, Clone
     out_path: Union[str, None] = typer.Option(
-        None, "--out-path", help="(optional: create|download|apply|clone) Path to save the output file"),
+        None, "--out-path",
+        help="(optional: create, download, apply, clone) Path to save the output file."
+    ),
     # update
     byosnaps_list: str = typer.Option(
         None, "--byosnaps",
         help=(
             "(optional: update) Comma separated list of BYOSnap ids and versions. "
-            "Eg: service-1:v1.0.0,service-2:v1.0.0"
+            "Eg: `service-1:v1.0.0,service-2:v1.0.0`."
         )
     ),
     byogs_list: str = typer.Option(
         None, "--byogs",
         help=(
             "(optional: update) Comma separated list of BYOGs fleet_name:tag. "
-            "Eg: fleet-1:v1.0.0,fleet-2:v1.0.0"
+            "Eg: `fleet-1:v1.0.0,fleet-2:v1.0.0`."
         )
     ),
     # create, update, promote, apply, clone
@@ -716,10 +783,12 @@ def snapend(
     ),
     # overrides
     api_key: Union[str, None] = typer.Option(
-        None, "--api-key", help="API Key override.", callback=api_key_context_callback
+        None, "--api-key",
+        help="API Key override.", callback=api_key_context_callback
     ),
     profile: Union[str, None] = typer.Option(
-        None, "--profile", help="Profile from the Snapser config to use.", callback=profile_context_callback
+        None, "--profile",
+        help="Profile from the Snapser config to use.", callback=profile_context_callback
     ),
 ) -> None:
     """
@@ -765,26 +834,33 @@ def byows(
     # attach
     snapend_id: str = typer.Option(
         None, "--snapend-id",
-        help=("(req: attach, reset) Your Snapend Id")
+        help=("(required: attach, reset) Snapend Id.")
     ),
     byosnap_id: str = typer.Option(
         None, "--byosnap-id",
-        help=("(req: attach) Your BYOSnap Id")
+        help=("(required: attach) BYOSnap Id. Should start with `byosnap-`.")
     ),
     http_port: str = typer.Option(
         None, "--http-port",
-        help=("(oneof: attach) HTTP port of your local server. One of --http-port or --grpc-port is required.")
+        help=(
+            "(use: attach) HTTP port of your local server. "
+            "One of --http-port or --grpc-port is required."
+        )
     ),
     grpc_port: str = typer.Option(
         None, "--grpc-port",
-        help=("(oneof: attach) gRPC port of your local server. One of --http-port or --grpc-port is required.")
+        help=(
+            "(use: attach) gRPC port of your local server. "
+            "One of --http-port or --grpc-port is required."
+        )
     ),
     # overrides
     api_key: Union[str, None] = typer.Option(
         None, "--api-key", help="API Key override.", callback=api_key_context_callback
     ),
     profile: Union[str, None] = typer.Option(
-        None, "--profile", help="Profile from the Snapser config to use.", callback=profile_context_callback
+        None, "--profile",
+        help="Profile from the Snapser config to use.", callback=profile_context_callback
     ),
 ) -> None:
     """
@@ -815,8 +891,10 @@ def snaps(
         ..., help="Snaps Subcommands: " + ", ".join(Snaps.SUBCOMMANDS) + "."
     ),
     out_path_filename: Union[str, None] = typer.Option(
-        None, "--out-path-filename", help=(
-            "(optional: enumerate) Path and filename to output the snaps list. The filename should end with .json."
+        None, "--out-path-filename",
+        help=(
+            "(optional: enumerate) Path and filename to output the snaps list. "
+            "The filename should end with `.json`."
         )
     ),
     # overrides
@@ -824,7 +902,8 @@ def snaps(
         None, "--api-key", help="API Key override.", callback=api_key_context_callback
     ),
     profile: Union[str, None] = typer.Option(
-        None, "--profile", help="Profile from the Snapser config to use.", callback=profile_context_callback
+        None, "--profile",
+        help="Profile from the Snapser config to use.", callback=profile_context_callback
     ),
 ) -> None:
     """
@@ -851,61 +930,81 @@ def snapend_manifest(
         ..., help="Snapend Manifest Subcommands: " + ", ".join(SnapendManifest.SUBCOMMANDS) + "."
     ),
     name: Union[str, None] = typer.Option(
-        None, "--name", help="(req: create) Name for your snapend."
+        None, "--name",
+        help="(required: create) Name for your snapend."
     ),
     env: Union[str, None] = typer.Option(
-        None, "--env", help=(
-            "(req: create) Environment for your snapend - " +
+        None, "--env",
+        help=(
+            "(required: create) Environment for your snapend - " +
             ", ".join(SnapendManifest.ENVIRONMENTS) + "."
         )
     ),
     manifest_path_filename: Union[str, None] = typer.Option(
-        None, "--manifest-path-filename", help=(
-            "(req: sync, upgrade) Full Path to the manifest file including the filename."
+        None, "--manifest-path-filename",
+        help=(
+            "(required: sync, upgrade, update) Full Path to the manifest file "
+            "including the filename."
         )
     ),
     snaps_list_str: str = typer.Option(
-        None, "--snaps", help=(
-            "(use: create, sync, upgrade) Comma separated list of snap ids to add, sync or upgrade. "
+        None, "--snaps",
+        help=(
+            "(use: create, sync, upgrade) Comma separated list of snap ids to add, " +
+            "sync or upgrade. snaps(" + ", ".join(SERVICE_IDS) + ")."
         )
     ),
     features: str = typer.Option(
-        None, "--features", help=(
-            "(use: create, sync) Comma separated list of feature flags to add, sync. "
-            "Features: " + ", ".join(SnapendManifest.FEATURES)
+        None, "--features",
+        help=(
+            "(use: create, sync) Comma separated list of feature flags to add, sync. " +
+            "features(" + ", ".join(SnapendManifest.FEATURES) + ")."
         )
     ),
     add_snaps: str = typer.Option(
-        None, "--add-snaps", help=(
-            "(use: update) Comma separated list of snap ids to add. "
+        None, "--add-snaps",
+        help=(
+            "(use: update) Comma separated list of snap ids to add. " +
+            "snaps(" + ", ".join(SERVICE_IDS) + ")."
         )
     ),
     remove_snaps: str = typer.Option(
-        None, "--remove-snaps", help=(
-            "(use: update) Comma separated list of snap ids to remove. "
+        None, "--remove-snaps",
+        help=(
+            "(use: update) Comma separated list of snap ids to remove. snaps(" +
+            ", ".join([s for s in SERVICE_IDS if s.lower() != SnapendManifest.AUTH_SNAP_ID]) +
+            ")."
         )
     ),
     add_features: str = typer.Option(
-        None, "--add-features", help=(
-            "(use: update) Comma separated list of features to add. "
+        None, "--add-features",
+        help=(
+            "(use: update) Comma separated list of features to add. " +
+            "features(" + ", ".join(SnapendManifest.FEATURES) + ")."
         )
     ),
     remove_features: str = typer.Option(
-        None, "--remove-features", help=(
-            "(use: update) Comma separated list of features to remove. "
+        None, "--remove-features",
+        help=(
+            "(use: update) Comma separated list of features to remove. " +
+            "features(" + ", ".join(SnapendManifest.FEATURES) + ")."
         )
     ),
     out_path_filename: Union[str, None] = typer.Option(
-        None, "--out-path-filename", help=(
-            "(optional: enumerate) Path and filename to output the manifest. The filename should end with .json or .yaml"
+        None, "--out-path-filename",
+        help=(
+            "(required: create, sync, upgrade, update) (optional: enumerate) Path and filename to "
+            "output the manifest. The filename should end with .json or .yaml"
         )
     ),
     # overrides
     api_key: Union[str, None] = typer.Option(
-        None, "--api-key", help="API Key override.", callback=api_key_context_callback
+        None, "--api-key",
+        help="API Key override.", callback=api_key_context_callback
     ),
     profile: Union[str, None] = typer.Option(
-        None, "--profile", help="Profile from the Snapser config to use.", callback=profile_context_callback
+        None, "--profile",
+        help="Profile from the Snapser config to use.", callback=profile_context_callback
     ),
 ) -> None:
     """

snapctl/utils/telemetry.py

@@ -3,13 +3,14 @@ Telemetry utilities for snapctl
 '''
 from __future__ import annotations
 from typing import Any, Dict, Optional
+import os
 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.config.constants import AMPLITUDE_HTTP_US, AMPLITUDE_HTTP_EU, TEST_MODE
 from snapctl.utils.helper import get_config_value
 from snapctl.utils.echo import info
 
@@ -65,6 +66,10 @@ def _is_active(ctx: Optional[typer.Context]) -> tuple[bool, bool, Optional[str]]
     if not api_key or api_key == '':
         return (False, False, None)
     telemetry_active = get_config_value(env, "TELEMETRY_ACTIVE") == "true"
+    # If we are running unit test; disable tracking
+    is_test = os.getenv(TEST_MODE) == "true"
+    if is_test:
+        telemetry_active = False
     dry_run = get_config_value(env, "TELEMETRY_DRY_RUN") == "true"
     return (telemetry_active, dry_run, api_key)
 

{snapctl-1.1.2.dist-info → snapctl-1.1.3.dist-info}/METADATA

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

{snapctl-1.1.2.dist-info → snapctl-1.1.3.dist-info}/RECORD

@@ -3,7 +3,7 @@ snapctl/__main__.py,sha256=43jKoTk8b85hk_MT6499N3ruHdEfM8WBImd_-3VzjI8,116
 snapctl/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 snapctl/commands/application.py,sha256=hG5_llFKpm-PrP_8NOMz_5Ks9IvC_lzdbCBWtSUzmhQ,5342
 snapctl/commands/byogs.py,sha256=bomIucEEftlIsCB369cYyfxXStSrW7OgjAcaEUPteGI,20193
-snapctl/commands/byosnap.py,sha256=pWzh0myELb2qefnerA3tIFmp5R_uk3JQs74zetiXYw4,78204
+snapctl/commands/byosnap.py,sha256=8AknaioqtPEgvIt5sGvPkl0mVrCmrOVpu2eCq95KO8c,78210
 snapctl/commands/byows.py,sha256=91bpV-LXOIbDDx3vNj9Xl_vRBTQeedyzl6fHZcpG6ig,18978
 snapctl/commands/game.py,sha256=F6TL5T3i8yZAQxfsx0uma2tbLHCQ_gqA1wj6oxkAgGk,5236
 snapctl/commands/generate.py,sha256=9-NlZVQllBT2LZT_t9S3ztwtHzTbM-C8_x0f6z70U3g,5606
@@ -13,9 +13,9 @@ snapctl/commands/snapend_manifest.py,sha256=F4Ql-jkfPvkTrrQ5RfTXp8Jk5s4EFSkWtoOv
 snapctl/commands/snaps.py,sha256=VI7B1FtrYAyJTxtQcOU6BgImwRND0ZXJGTWSpCXKzW0,4103
 snapctl/config/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 snapctl/config/app.py,sha256=U9Mm0BbGJoqcmBBam2tN7F-oTf_u9dK6EJsiB-yVvKg,888
-snapctl/config/constants.py,sha256=FEKC3XjoEMAwAjWmLkemeH_Ek2F5BTn5_giNz_eANm0,4373
+snapctl/config/constants.py,sha256=VEQieWjO9Nl80hM9dJgUuhcK4_8eZbe-cUsjB6UGGxw,4405
 snapctl/config/endpoints.py,sha256=jD0n5ocJBbIkrb97F2_r9hqAHzUuddAqzqqBAPUKDTI,477
-snapctl/config/hashes.py,sha256=3OKAyOxQPnn--_hvPIzFJnhC8NVfQK4WT-RH4PHEV1w,5242
+snapctl/config/hashes.py,sha256=PVYSDrSiRW-WTclqji-E9J70r5Ff3-nGr0cz81WOMoc,5344
 snapctl/data/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 snapctl/data/profiles/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 snapctl/data/profiles/snapser-byosnap-profile.json,sha256=c7oIzMJewVQaoLaXCBPXlH-k5cL9DCz6q4IixsWWD9c,2404
@@ -27,6 +27,7 @@ snapctl/data/releases/1.0.3.mdx,sha256=Ifm6kRQQghCWx_OJ3shNOxozUP3hH_yt8dMap7B-1
 snapctl/data/releases/1.0.4.mdx,sha256=hKwi0tormf0gvKAY5W4G1BY7L6fgwOzlw3R-WGSH49g,243
 snapctl/data/releases/1.1.0.mdx,sha256=w_X9SsMH-ghex8UYQn9b1AcQT9i3eeAlQWP2YCVU_kY,1303
 snapctl/data/releases/1.1.2.mdx,sha256=_hHvOSR5O9QJBwgqhglxazcpR3rBiJE2WZn5wzGEFSA,244
+snapctl/data/releases/1.1.3.mdx,sha256=qil7MseqvmIDgfwjEFwCOBTD3yYN3xQ-n3zc71Cysdg,136
 snapctl/data/releases/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 snapctl/data/releases/beta-0.46.0.mdx,sha256=_MJA7TnnJjAnNm_EOvoBiz7FjHwl4c49sYtZ9r4KZQE,2386
 snapctl/data/releases/beta-0.46.4.mdx,sha256=3-ojdCyvax27sdd8nKmcP0zfCWEzi_edPbSlkFqla4o,173
@@ -41,16 +42,16 @@ snapctl/data/releases/beta-0.49.3.mdx,sha256=XmSfpiH-LqvKS2REJ5FGDcLgyEN-OcSzwrX
 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=ZTHmYAW_np3ojTGO7l6eBu2Anbm84uWt9ry0HGQ8K4M,32478
+snapctl/main.py,sha256=t1iBPOjLw774D9NbHCpHwt1whyYOj9GmD9jODbqK8jk,34036
 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=9fxrPW9kNJwiJvJBFy9RlAP4qGRcPTOHfQb3pQh3CMg,1446
 snapctl/utils/exceptions.py,sha256=deLs6sOKIUrhjKNgiMpNC1S6lkU0rpZ7Ml4Tx1CN_Ss,155
 snapctl/utils/helper.py,sha256=8PwlN8xcx4ivHhEudt-PwAl1IL4h1vR0ah7qPEdzWhU,7424
-snapctl/utils/telemetry.py,sha256=_VntKXUrKgJoLKCskH0Z5VhthiVo8CP572U0mcZIH4k,5028
-snapctl-1.1.2.dist-info/LICENSE,sha256=6AcXm54KFSpmUI1ji9NIBd4Xl-DtjTqiyjBzfVb_CEk,2804
-snapctl-1.1.2.dist-info/METADATA,sha256=QY8KxqDXcwjmJrne1m9UiBXlvzau41rDzsihNv4N6NY,46266
-snapctl-1.1.2.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-snapctl-1.1.2.dist-info/entry_points.txt,sha256=tkKW9MzmFdRs6Bgkv29G78i9WEBK4WIOWunPfe3t2Wg,44
-snapctl-1.1.2.dist-info/RECORD,,
+snapctl/utils/telemetry.py,sha256=kyzKnBoQlJaCSsNjm4bOA9Kh1TMBXWSlsk2hmSZF5ig,5195
+snapctl-1.1.3.dist-info/LICENSE,sha256=6AcXm54KFSpmUI1ji9NIBd4Xl-DtjTqiyjBzfVb_CEk,2804
+snapctl-1.1.3.dist-info/METADATA,sha256=5cz2QNoGNKXVfzqroVGaTlUCE09BqcAROViun4_h69U,46266
+snapctl-1.1.3.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+snapctl-1.1.3.dist-info/entry_points.txt,sha256=tkKW9MzmFdRs6Bgkv29G78i9WEBK4WIOWunPfe3t2Wg,44
+snapctl-1.1.3.dist-info/RECORD,,