snapctl 0.26.0__tar.gz → 0.29.1__tar.gz

{snapctl-0.26.0 → snapctl-0.29.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: snapctl
-Version: 0.26.0
+Version: 0.29.1
 Summary: Snapser CLI Tool
 Author: Ajinkya Apte
 Author-email: aj@snapser.com
@@ -443,10 +443,14 @@ snapctl snapend download --help
 #   snapend-manifest(yaml, json)
 #   client-sdk(unity, unreal, roblox, godot, cocos, ios-objc, ios-swift, android-java, android-kotlin, web-ts, web-js),
 #   server-sdk(csharp, cpp, lua, ts, go, python, kotlin, java, c, node, js, perl, php, closure, ruby, rust),
-#   protos(go, csharp, cpp, python)
+#   protos(go, csharp, cpp, raw)
+# $protos-category = messages or services (only with --type protos)
+# $auth-type = user or app (only with --type server-sdk)
 # Example:
 # snapctl snapend download gx5x6bc0 --category snapend-manifest --type yaml
 # snapctl snapend download gx5x6bc0 --category client-sdk --type unity
+# snapctl snapend download gx5x6bc0 --category server-sdk --type unity --auth-type app
+# snapctl snapend download gx5x6bc0 --category protos --type raw --protos-category messages
 snapctl snapend download $snapend_id --category $category --type $type
 ```
 
@@ -455,10 +459,10 @@ snapctl snapend download $snapend_id --category $category --type $type
 Clone a Snapend from an existing manifest. Passing the blocking flag ensures your CLI command waits till the new Snapend is up.
 
 ```
-# Help for the download command
+# Help for the clone command
 snapctl snapend clone --help
 
-# Download your Snapend SDK and Protos
+# Clone your Snapend
 # $gameId = Game Id
 # $snapendName = Name of your new Snapend
 # $env = One of development, staging
@@ -475,10 +479,10 @@ Apply changes to your Snapend from a manifest. You should have the latest manife
 a user stomping over someone elses changes. Passing the blocking flag ensures your CLI command waits till the update is complete.
 
 ```
-# Help for the download command
+# Help for the apply command
 snapctl snapend apply --help
 
-# Download your Snapend SDK and Protos
+# Apply changes to a snapend via manifest
 # $pathToManifest = Path to the manifest file; should include the file name
 # Example:
 # snapctl snapend apply --manifest-path "C:\Users\name\Downloads\snapser-ox1bcyim-manifest.json" --blocking

{snapctl-0.26.0 → snapctl-0.29.1}/README.md

@@ -426,10 +426,14 @@ snapctl snapend download --help
 #   snapend-manifest(yaml, json)
 #   client-sdk(unity, unreal, roblox, godot, cocos, ios-objc, ios-swift, android-java, android-kotlin, web-ts, web-js),
 #   server-sdk(csharp, cpp, lua, ts, go, python, kotlin, java, c, node, js, perl, php, closure, ruby, rust),
-#   protos(go, csharp, cpp, python)
+#   protos(go, csharp, cpp, raw)
+# $protos-category = messages or services (only with --type protos)
+# $auth-type = user or app (only with --type server-sdk)
 # Example:
 # snapctl snapend download gx5x6bc0 --category snapend-manifest --type yaml
 # snapctl snapend download gx5x6bc0 --category client-sdk --type unity
+# snapctl snapend download gx5x6bc0 --category server-sdk --type unity --auth-type app
+# snapctl snapend download gx5x6bc0 --category protos --type raw --protos-category messages
 snapctl snapend download $snapend_id --category $category --type $type
 ```
 
@@ -438,10 +442,10 @@ snapctl snapend download $snapend_id --category $category --type $type
 Clone a Snapend from an existing manifest. Passing the blocking flag ensures your CLI command waits till the new Snapend is up.
 
 ```
-# Help for the download command
+# Help for the clone command
 snapctl snapend clone --help
 
-# Download your Snapend SDK and Protos
+# Clone your Snapend
 # $gameId = Game Id
 # $snapendName = Name of your new Snapend
 # $env = One of development, staging
@@ -458,10 +462,10 @@ Apply changes to your Snapend from a manifest. You should have the latest manife
 a user stomping over someone elses changes. Passing the blocking flag ensures your CLI command waits till the update is complete.
 
 ```
-# Help for the download command
+# Help for the apply command
 snapctl snapend apply --help
 
-# Download your Snapend SDK and Protos
+# Apply changes to a snapend via manifest
 # $pathToManifest = Path to the manifest file; should include the file name
 # Example:
 # snapctl snapend apply --manifest-path "C:\Users\name\Downloads\snapser-ox1bcyim-manifest.json" --blocking

{snapctl-0.26.0 → snapctl-0.29.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "snapctl"
-version = "0.26.0"
+version = "0.29.1"
 description = "Snapser CLI Tool"
 authors = ["Ajinkya Apte <aj@snapser.com>"]
 readme = "README.md"

{snapctl-0.26.0 → snapctl-0.29.1}/snapctl/commands/byogs.py

@@ -161,16 +161,18 @@ class ByoGs:
             ) as progress:
                 progress.add_task(
                     description='Building your snap...', total=None)
+                docker_file_path = f"{self.path}/{self.dockerfile}"
                 if platform == "win32":
                     response = subprocess.run([
                         # f"docker build --no-cache -t {tag} {path}"
-                        'docker', 'build', '--platform', build_platform, '-t', image_tag, self.path
+                        'docker', 'build', '--platform', build_platform, '-t', image_tag,
+                        '-f', docker_file_path,  self.path
                     ], shell=True, check=False)
                     # stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT)
                 else:
                     response = subprocess.run([
                         # f"docker build --no-cache -t {tag} {path}"
-                        f"docker build --platform {build_platform} -t {image_tag} {self.path}"
+                        f"docker build --platform {build_platform} -t {image_tag} -f {docker_file_path} {self.path}"
                     ], shell=True, check=False)
                     # stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT)
                 if response.returncode:

{snapctl-0.26.0 → snapctl-0.29.1}/snapctl/commands/byosnap.py

@@ -169,16 +169,18 @@ class ByoSnap:
             ) as progress:
                 progress.add_task(
                     description='Building your snap...', total=None)
+                docker_file_path = f"{self.path}/{self.dockerfile}"
                 if platform == "win32":
                     response = subprocess.run([
                         # f"docker build --no-cache -t {tag} {path}"
-                        'docker', 'build', '--platform', build_platform, '-t', image_tag, self.path
+                        'docker', 'build', '--platform', build_platform, '-t', image_tag,
+                        '-f', docker_file_path,  self.path
                     ], shell=True, check=False)
                     # stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT)
                 else:
                     response = subprocess.run([
                         # f"docker build --no-cache -t {tag} {path}"
-                        f"docker build --platform {build_platform} -t {image_tag} {self.path}"
+                        f"docker build --platform {build_platform} -t {image_tag} -f {docker_file_path} {self.path}"
                     ], shell=True, check=False)
                     # stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT)
                 if response.returncode:

{snapctl-0.26.0 → snapctl-0.29.1}/snapctl/commands/snapend.py

@@ -30,6 +30,7 @@ class Snapend:
         'client-sdk', 'server-sdk', 'protos', 'admin-settings', 'snapend-manifest'
     ]
     DOWNLOAD_TYPE_NOT_REQUIRED = ['admin-settings']
+    PROTOS_CATEGORY = ['messages', 'services']
     AUTH_TYPES = ['user', 'app']
     ENV_TYPES = ['DEVELOPMENT', 'STAGING']
     BLOCKING_CALL_SLEEP = 5
@@ -45,7 +46,7 @@ class Snapend:
         # Clone, Apply, Promote
         manifest_path: str | None,
         # Download
-        category: str, platform_type: str, auth_type: str, snaps: str | None,
+        category: str, platform_type: str, protos_category: str, auth_type: str, snaps: str | None,
         # Clone, Apply, Promote, Download
         out_path: str | None,
         # Update
@@ -66,6 +67,7 @@ class Snapend:
         self.download_types: Union[
             dict[str, dict[str, str]], None
         ] = Snapend._make_download_type(category)
+        self.protos_category: str = protos_category
         self.auth_type: str = auth_type
         self.platform_type: str = platform_type
         self.out_path: str | None = out_path
@@ -179,14 +181,18 @@ class Snapend:
                 f"download?category={self.category}"
             )
             if self.category not in Snapend.DOWNLOAD_TYPE_NOT_REQUIRED:
-                url += (
-                    f"&type={self.download_types[self.platform_type]['type']}"
-                    f"&subtype={self.download_types[self.platform_type]['subtype']}"
-                )
-            url_auth_type: str = 'user'
-            if self.category == 'server-sdk' and self.auth_type == 'app':
-                url_auth_type = 'app'
-            url += f"&auth_type={url_auth_type}"
+                url += f"&type={self.download_types[self.platform_type]['type']}"
+            # If Protos, add protos category
+            if self.category == 'protos':
+                url += f"&subtype={self.protos_category}"
+            # If client or server SDK, add sub type and auth type
+            if self.category in ['client-sdk', 'server-sdk']:
+                url += f"&subtype={self.download_types[self.platform_type]['subtype']}"
+                url_auth_type: str = 'user'
+                if self.category == 'server-sdk' and self.auth_type == 'app':
+                    url_auth_type = 'app'
+                url += f"&auth_type={url_auth_type}"
+            # Customize snaps
             if self.snaps:
                 url += f"&snaps={self.snaps}"
             res = requests.get(
@@ -200,6 +206,11 @@ class Snapend:
                     f"snapser-{self.snapend_id}-"
                     f"manifest.{self.download_types[self.platform_type]['type']}"
                 )
+            elif self.category == 'protos':
+                fn = (
+                    f"snapser-{self.snapend_id}-{self.category}"
+                    f"-{self.platform_type}-{self.protos_category}.zip"
+                )
             else:
                 fn = (
                     f"snapser-{self.snapend_id}-{self.category}"
@@ -292,6 +303,13 @@ class Snapend:
                     "Please enter a valid path to save your output file"
                 )
                 return response
+            # Check the Protos category
+            if self.category == 'protos' and self.protos_category not in Snapend.PROTOS_CATEGORY:
+                response['msg'] = (
+                    "Invalid Protos category. Valid categories are "
+                    f"{', '.join(Snapend.PROTOS_CATEGORY)}."
+                )
+                return response
             # Check the auth type
             if self.category == 'server-sdk' and self.auth_type not in Snapend.AUTH_TYPES:
                 response['msg'] = (

{snapctl-0.26.0 → snapctl-0.29.1}/snapctl/config/constants.py

@@ -2,7 +2,7 @@
 Constants used by snapctl
 """
 COMPANY_NAME = 'Snapser'
-VERSION = '0.26.0'
+VERSION = '0.29.1'
 CONFIG_FILE_MAC = '~/.snapser/config'
 CONFIG_FILE_WIN = '%homepath%\\.snapser\\config'
 

{snapctl-0.26.0 → snapctl-0.29.1}/snapctl/config/hashes.py

@@ -120,10 +120,22 @@ SERVER_SDK_TYPES: dict[str, dict[str, str]] = {
 }
 
 PROTOS_TYPES: dict[str, dict[str, str]] = {
+    'cpp': {
+        'type': 'cpp',
+        'subtype': '',
+    },
+    'csharp': {
+        'type': 'csharp',
+        'subtype': '',
+    },
     'go': {
         'type': 'go',
         'subtype': '',
     },
+    'raw': {
+        'type': 'raw',
+        'subtype': '',
+    },
 }
 
 SNAPEND_MANIFEST_TYPES: dict[str, dict[str, str]] = {

{snapctl-0.26.0 → snapctl-0.29.1}/snapctl/main.py

@@ -468,6 +468,13 @@ def snapend(
             ", ".join(SNAPEND_MANIFEST_TYPES.keys()) + ")"
         )
     ),
+    protos_category: str = typer.Option(
+        'messages', "--protos-category",
+        help=(
+            "(optional: download) Only applicable for --category protos --protos-category"
+            "Protos-Category: (" + ", ".join(Snapend.PROTOS_CATEGORY) + ")"
+        )
+    ),
     auth_type: str = typer.Option(
         'user', "--auth-type",
         help=(
@@ -538,7 +545,7 @@ def snapend(
         # Apply, Clone
         manifest_path,
         # Download
-        category, platform_type, auth_type, snaps,
+        category, platform_type, protos_category, auth_type, snaps,
         # Download, Apply and Clone
         out_path,
         # Update