snapctl 0.22.3__tar.gz → 0.26.1__tar.gz

{snapctl-0.22.3 → snapctl-0.26.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: snapctl
-Version: 0.22.3
+Version: 0.26.1
 Summary: Snapser CLI Tool
 Author: Ajinkya Apte
 Author-email: aj@snapser.com
@@ -10,6 +10,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Dist: configparser (>=6.0.0,<7.0.0)
+Requires-Dist: pyfiglet (>=1.0.2,<2.0.0)
 Requires-Dist: requests (>=2.28.2,<3.0.0)
 Requires-Dist: typer[all] (>=0.7.0,<0.8.0)
 Description-Content-Type: text/markdown
@@ -392,7 +393,7 @@ snapctl byogs publish-version --help
 snapctl byogs publish-version $byogs_sid --tag $image_tag --prefix $prefix --version $version --http-port $ingress_port
 ```
 
-### Snapend
+### Game
 
 #### 1. snapend help
 
@@ -403,27 +404,89 @@ See all the supported commands
 snapctl snapend --help
 ```
 
+#### 2. Create a game
+Create a game
+```
+snapctl game create --name $gameName
+```
+
+#### 3. Enumerate games
+List all the games
+```
+snapctl game enumerate
+```
+
+
+### Snapend
+
+#### 1. snapend help
+
+See all the supported commands
+
+```
+# Help for the snapend command
+snapctl snapend --help
+```
+
 #### 2. Snapend Downloads
 
-Download SDKs and Protos for your Snapend
+Download Manifest, SDKs and Protos for your Snapend
 
 ```
-# Help for the byogs command
+# Help for the download command
 snapctl snapend download --help
 
 # Download your Snapend SDK and Protos
 # $snapend_id = Cluster Id
-# $category = client-sdk, server-sdk, protos, admin-settings
-# $sdk_type = One of the supported SDK names:
-# 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)
+# $category = snapend-manifest, client-sdk, server-sdk, protos
+# $type = One of the supported types:
+#   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)
 # Example:
+# snapctl snapend download gx5x6bc0 --category snapend-manifest --type yaml
 # snapctl snapend download gx5x6bc0 --category client-sdk --type unity
-snapctl snapend download $snapend_id --category $category --type $sdk_type
+snapctl snapend download $snapend_id --category $category --type $type
+```
+
+#### 3. Clone Snapend
+
+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
+snapctl snapend clone --help
+
+# Download your Snapend SDK and Protos
+# $gameId = Game Id
+# $snapendName = Name of your new Snapend
+# $env = One of development, staging
+# $pathToManifest = Path to the manifest file; should include the file name
+# Example:
+# snapctl snapend clone --game-id 2581d802-aca-496c-8a76-1953ad0db165 --name new-snapend --env development --manifest-path "C:\Users\name\Downloads\snapser-ox1bcyim-manifest.json" --blocking
+snapctl snapend clone --game-id $gameId --name $snapendName --env $env --manifest-path "$pathToManifest"
+snapctl snapend clone --game-id $gameId --name $snapendName --env $env --manifest-path "$pathToManifest" --blocking
+```
+
+#### 4. Apply Snapend Changes
+
+Apply changes to your Snapend from a manifest. You should have the latest manifest before applying changes. This is to prevent
+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
+snapctl snapend apply --help
+
+# Download your Snapend SDK and Protos
+# $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 snapend apply --manifest-path "$pathToManifest"
+snapctl snapend apply --manifest-path "$pathToManifest" --blocking
 ```
 
-#### 3. Update Snapend BYOSnap or BYOGs versions
+#### 5. Update Snapend BYOSnap or BYOGs versions
 
 Update your BYOSnap or BYOGs versions for the Snapend
 
@@ -443,7 +506,7 @@ snapctl snapend update --help
 snapctl snapend update $snapend_id --byosnaps $byosnaps --byogs $byogs --blocking
 ```
 
-#### 4. Get the Snapend state
+#### 6. Get the Snapend state
 
 Get the Snapend state
 

{snapctl-0.22.3 → snapctl-0.26.1}/README.md

@@ -376,7 +376,7 @@ snapctl byogs publish-version --help
 snapctl byogs publish-version $byogs_sid --tag $image_tag --prefix $prefix --version $version --http-port $ingress_port
 ```
 
-### Snapend
+### Game
 
 #### 1. snapend help
 
@@ -387,27 +387,89 @@ See all the supported commands
 snapctl snapend --help
 ```
 
+#### 2. Create a game
+Create a game
+```
+snapctl game create --name $gameName
+```
+
+#### 3. Enumerate games
+List all the games
+```
+snapctl game enumerate
+```
+
+
+### Snapend
+
+#### 1. snapend help
+
+See all the supported commands
+
+```
+# Help for the snapend command
+snapctl snapend --help
+```
+
 #### 2. Snapend Downloads
 
-Download SDKs and Protos for your Snapend
+Download Manifest, SDKs and Protos for your Snapend
 
 ```
-# Help for the byogs command
+# Help for the download command
 snapctl snapend download --help
 
 # Download your Snapend SDK and Protos
 # $snapend_id = Cluster Id
-# $category = client-sdk, server-sdk, protos, admin-settings
-# $sdk_type = One of the supported SDK names:
-# 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)
+# $category = snapend-manifest, client-sdk, server-sdk, protos
+# $type = One of the supported types:
+#   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)
 # Example:
+# snapctl snapend download gx5x6bc0 --category snapend-manifest --type yaml
 # snapctl snapend download gx5x6bc0 --category client-sdk --type unity
-snapctl snapend download $snapend_id --category $category --type $sdk_type
+snapctl snapend download $snapend_id --category $category --type $type
+```
+
+#### 3. Clone Snapend
+
+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
+snapctl snapend clone --help
+
+# Download your Snapend SDK and Protos
+# $gameId = Game Id
+# $snapendName = Name of your new Snapend
+# $env = One of development, staging
+# $pathToManifest = Path to the manifest file; should include the file name
+# Example:
+# snapctl snapend clone --game-id 2581d802-aca-496c-8a76-1953ad0db165 --name new-snapend --env development --manifest-path "C:\Users\name\Downloads\snapser-ox1bcyim-manifest.json" --blocking
+snapctl snapend clone --game-id $gameId --name $snapendName --env $env --manifest-path "$pathToManifest"
+snapctl snapend clone --game-id $gameId --name $snapendName --env $env --manifest-path "$pathToManifest" --blocking
+```
+
+#### 4. Apply Snapend Changes
+
+Apply changes to your Snapend from a manifest. You should have the latest manifest before applying changes. This is to prevent
+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
+snapctl snapend apply --help
+
+# Download your Snapend SDK and Protos
+# $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 snapend apply --manifest-path "$pathToManifest"
+snapctl snapend apply --manifest-path "$pathToManifest" --blocking
 ```
 
-#### 3. Update Snapend BYOSnap or BYOGs versions
+#### 5. Update Snapend BYOSnap or BYOGs versions
 
 Update your BYOSnap or BYOGs versions for the Snapend
 
@@ -427,7 +489,7 @@ snapctl snapend update --help
 snapctl snapend update $snapend_id --byosnaps $byosnaps --byogs $byogs --blocking
 ```
 
-#### 4. Get the Snapend state
+#### 6. Get the Snapend state
 
 Get the Snapend state
 

{snapctl-0.22.3 → snapctl-0.26.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "snapctl"
-version = "0.22.3"
+version = "0.26.1"
 description = "Snapser CLI Tool"
 authors = ["Ajinkya Apte <aj@snapser.com>"]
 readme = "README.md"
@@ -14,6 +14,7 @@ python = "^3.10"
 typer = {extras = ["all"], version = "^0.7.0"}
 requests = "^2.28.2"
 configparser = "^6.0.0"
+pyfiglet = "^1.0.2"
 
 
 [build-system]

{snapctl-0.22.3 → snapctl-0.26.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.22.3 → snapctl-0.26.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.1/snapctl/commands/game.py

@@ -0,0 +1,107 @@
+"""
+  Snapend CLI commands
+"""
+import requests
+from requests.exceptions import RequestException
+
+from rich.progress import Progress, SpinnerColumn, TextColumn
+from snapctl.config.constants import SERVER_CALL_TIMEOUT
+from snapctl.types.definitions import ResponseType
+from snapctl.utils.echo import error, success
+
+
+class Game:
+    """
+      CLI commands exposed for a Game
+    """
+    SUBCOMMANDS = ['create', 'enumerate']
+
+    def __init__(
+            self, subcommand: str, base_url: str, api_key: str | None, name: str | None
+    ) -> None:
+        self.subcommand: str = subcommand
+        self.base_url: str = base_url
+        self.api_key: str = api_key
+        self.name: str | None = name
+
+    def validate_input(self) -> ResponseType:
+        """
+          Validator
+        """
+        response: ResponseType = {
+            'error': True,
+            'msg': '',
+            'data': []
+        }
+        # Check API Key and Base URL
+        if not self.api_key or self.base_url == '':
+            response['msg'] = "Missing API Key."
+            return response
+        # Check subcommand
+        if not self.subcommand in Game.SUBCOMMANDS:
+            response['msg'] = \
+                f"Invalid command. Valid commands are {', '.join(Game.SUBCOMMANDS)}."
+            return response
+        # Check sdk-download commands
+        if self.subcommand == 'create':
+            if self.name is None or self.name == '':
+                response['msg'] = "Missing game name."
+                return response
+        # Send success
+        response['error'] = False
+        return response
+
+    def create(self) -> bool:
+        """
+          Create a game
+        """
+        with Progress(
+            SpinnerColumn(),
+            TextColumn("[progress.description]{task.description}"),
+            transient=True,
+        ) as progress:
+            progress.add_task(
+                description='Creating a new game on Snapser...', total=None)
+            try:
+                url = f"{self.base_url}/v1/snapser-api/games"
+                payload = {
+                    'name': self.name
+                }
+                res = requests.post(
+                    url, headers={'api-key': self.api_key},
+                    json=payload, timeout=SERVER_CALL_TIMEOUT
+                )
+                if res.ok:
+                    success(f"Game {self.name} has been created successfully.")
+                    return True
+                error('Unable to create a new game. Reason: ' + res.text)
+            except RequestException as e:
+                error(f"Exception: Unable to download the SDK {e}")
+            return False
+
+    def enumerate(self) -> bool:
+        """
+          Enumerate all games
+        """
+        with Progress(
+            SpinnerColumn(),
+            TextColumn("[progress.description]{task.description}"),
+            transient=True,
+        ) as progress:
+            progress.add_task(
+                description='Enumerating all your games...', total=None)
+            try:
+                url = f"{self.base_url}/v1/snapser-api/games"
+                res = requests.get(
+                    url, headers={'api-key': self.api_key},
+                    timeout=SERVER_CALL_TIMEOUT
+                )
+                response_json = res.json()
+                if res.ok:
+                    if 'games' in response_json:
+                        success(response_json['games'])
+                        return True
+                error(response_json)
+            except RequestException as e:
+                error(f"Exception: Unable to update your snapend {e}")
+            return False