snapctl 0.41.2__tar.gz → 0.42.0__tar.gz

{snapctl-0.41.2 → snapctl-0.42.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: snapctl
-Version: 0.41.2
+Version: 0.42.0
 Summary: Snapser CLI Tool
 Author: Ajinkya Apte
 Author-email: aj@snapser.com
@@ -22,11 +22,19 @@ Description-Content-Type: text/markdown
 Snapser has developed a CLI tool called **snapctl** that can be used on MaxOSX, Linux and Windows machines.
 Snapctl will be the best way for game studios to integrate Snapser into their build pipelines.
 
-## Dependencies
-
+### Python 3.X and Pip
 The Snapser CLI tool depends on Python 3.X and Pip. MacOS comes pre installed with Python. But
 please make sure you are running Python 3.X. On Windows, you can download Python 3.X from the
-Windows store. Some of the commands also need docker.
+Windows store.
+
+### Docker
+Some of the commands also need docker. You can download the latest version of Docker from the
+[Docker website](https://www.docker.com/products/docker-desktop).
+
+**IMPORTANT**: Open up Docker desktop and settings. Make sure this setting is disabled
+**Use containerd for pulling and storing images**. This is because Snapser uses Docker
+to build and push images to the Snapser registry. Having this setting enabled will
+cause issues with the Snapser CLI tool.
 
 ## Installation
 
@@ -132,10 +140,11 @@ SNAPSER_API_KEY=$your_api_key" | Out-File -encoding utf8 ~\.snapser\config
 ## Verify Snapctl installation
 
 ```
-snapctl --version
+snapctl validate
 ```
 
-You should see the latest snapctl version in the output
+Output will tell you if the Snapctl was able successfully validate your setup with the remote Snapser server
+or not.
 
 ## Advanced Setup
 
@@ -419,10 +428,10 @@ snapctl byogs sync --help
 # $skip-build = true/false. Default is false. Pass this flag as true to skip the build and head straight to tag and push. Build step needs to run and tagged using the --tag you pass to the publish-image command for this to work.
 # $image_tag = An image tag for your snap. Note snapctl adds a timestamp, allowing you to use the same command.
 # $snapend_id = Snapend Id
-# $fleet_name = Fleet Name
+# $fleet_names = Comma separated fleet names
 # Example:
-snapctl byogs sync --path /Users/DevName/Development/SnapserEngine/game_server --tag my-first-image --snapend-id "jxmmfryo" --fleet-name "my-fleet"
-snapctl byosnap sync --path $code_root_path --tag $image_tag --snapend-id $snapend_id --fleet-name $fleet_name
+snapctl byogs sync --path /Users/DevName/Development/SnapserEngine/game_server --tag my-first-image --snapend-id "jxmmfryo" --fleet-names "my-fleet,my-second-fleet"
+snapctl byosnap sync --path $code_root_path --tag $image_tag --snapend-id $snapend_id --fleet-names $fleet_names
 ```
 
 ### Game

{snapctl-0.41.2 → snapctl-0.42.0}/README.md

@@ -3,11 +3,19 @@
 Snapser has developed a CLI tool called **snapctl** that can be used on MaxOSX, Linux and Windows machines.
 Snapctl will be the best way for game studios to integrate Snapser into their build pipelines.
 
-## Dependencies
-
+### Python 3.X and Pip
 The Snapser CLI tool depends on Python 3.X and Pip. MacOS comes pre installed with Python. But
 please make sure you are running Python 3.X. On Windows, you can download Python 3.X from the
-Windows store. Some of the commands also need docker.
+Windows store.
+
+### Docker
+Some of the commands also need docker. You can download the latest version of Docker from the
+[Docker website](https://www.docker.com/products/docker-desktop).
+
+**IMPORTANT**: Open up Docker desktop and settings. Make sure this setting is disabled
+**Use containerd for pulling and storing images**. This is because Snapser uses Docker
+to build and push images to the Snapser registry. Having this setting enabled will
+cause issues with the Snapser CLI tool.
 
 ## Installation
 
@@ -113,10 +121,11 @@ SNAPSER_API_KEY=$your_api_key" | Out-File -encoding utf8 ~\.snapser\config
 ## Verify Snapctl installation
 
 ```
-snapctl --version
+snapctl validate
 ```
 
-You should see the latest snapctl version in the output
+Output will tell you if the Snapctl was able successfully validate your setup with the remote Snapser server
+or not.
 
 ## Advanced Setup
 
@@ -400,10 +409,10 @@ snapctl byogs sync --help
 # $skip-build = true/false. Default is false. Pass this flag as true to skip the build and head straight to tag and push. Build step needs to run and tagged using the --tag you pass to the publish-image command for this to work.
 # $image_tag = An image tag for your snap. Note snapctl adds a timestamp, allowing you to use the same command.
 # $snapend_id = Snapend Id
-# $fleet_name = Fleet Name
+# $fleet_names = Comma separated fleet names
 # Example:
-snapctl byogs sync --path /Users/DevName/Development/SnapserEngine/game_server --tag my-first-image --snapend-id "jxmmfryo" --fleet-name "my-fleet"
-snapctl byosnap sync --path $code_root_path --tag $image_tag --snapend-id $snapend_id --fleet-name $fleet_name
+snapctl byogs sync --path /Users/DevName/Development/SnapserEngine/game_server --tag my-first-image --snapend-id "jxmmfryo" --fleet-names "my-fleet,my-second-fleet"
+snapctl byosnap sync --path $code_root_path --tag $image_tag --snapend-id $snapend_id --fleet-names $fleet_names
 ```
 
 ### Game

{snapctl-0.41.2 → snapctl-0.42.0}/pyproject.toml

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

{snapctl-0.41.2 → snapctl-0.42.0}/snapctl/commands/byogs.py

@@ -38,7 +38,7 @@ class ByoGs:
         tag: Union[str, None] = None, path: Union[str, None] = None,
         resources_path: Union[str, None] = None, dockerfile: Union[str, None] = None,
         skip_build: bool = False, snapend_id: Union[str, None] = None,
-        fleet_name: Union[str, None] = None, blocking: bool = False
+        fleet_names: Union[str, None] = None, blocking: bool = False
     ) -> None:
         self.subcommand: str = subcommand
         self.base_url: str = base_url
@@ -58,7 +58,7 @@ class ByoGs:
         self.dockerfile: str = dockerfile
         self.skip_build: bool = skip_build
         self.snapend_id: Union[str, None] = snapend_id
-        self.fleet_name: Union[str, None] = fleet_name
+        self.fleet_names: Union[str, None] = fleet_names
         self.blocking: bool = blocking
         # Validate input
         self.validate_input()
@@ -383,9 +383,9 @@ class ByoGs:
                 snapctl_error(
                     message="Missing required parameter: snapend_id",
                     code=SNAPCTL_INPUT_ERROR)
-            if not self.fleet_name:
+            if not self.fleet_names:
                 snapctl_error(
-                    message="Missing required parameter: fleet_name",
+                    message="Missing required parameter: fleet_names",
                     code=SNAPCTL_INPUT_ERROR)
 
     # CRUD methods
@@ -448,10 +448,14 @@ class ByoGs:
         """
         self.tag = f'{self.tag}-{int(time.time())}'
         self.publish(no_exit=True)
-        byogs_list: str = f"{self.fleet_name}:{self.tag}"
+        fleet_list: List[str] = self.fleet_names.split(',')
+        byogs_list: List[str] = []
+        for fleet in fleet_list:
+            byogs_list.append(f"{fleet.strip()}:{self.tag}")
         snapend = Snapend(
             subcommand='update', base_url=self.base_url, api_key=self.api_key,
-            snapend_id=self.snapend_id, byogs=byogs_list, blocking=self.blocking
+            snapend_id=self.snapend_id, byogs=", ".join(map(str, byogs_list)),
+            blocking=self.blocking
         )
         snapend.update(no_exit=True)
         return snapctl_success(message='BYOGs sync successful')

{snapctl-0.41.2 → snapctl-0.42.0}/snapctl/config/constants.py

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

{snapctl-0.41.2 → snapctl-0.42.0}/snapctl/config/endpoints.py

@@ -1,7 +1,9 @@
-"""
+'''
 This file contains the endpoints for the Snapser API.
-"""
-END_POINTS = {
+'''
+from typing import Dict
+
+END_POINTS: Dict[str, str] = {
     'DEV': 'https://gateway.dev.snapser.io/snapser',
     'DEV_TWO': 'https://gateway.dev.snapser.io/devtwo',
     'PLAYTEST': 'https://gateway.dev.snapser.io/playtest',

{snapctl-0.41.2 → snapctl-0.42.0}/snapctl/main.py

@@ -266,11 +266,11 @@ def byogs(
     ),
     snapend_id: str = typer.Option(
         None, "--snapend-id",
-        help=("(req: sync) Snapend Id. NOTE: Development Snapends only.")
+        help=("(req: sync) Snapend Id.")
     ),
-    fleet_name: str = typer.Option(
-        None, "--fleet-name",
-        help=("(req: sync) Snapend Id. NOTE: Development Snapend fleets only. ")
+    fleet_names: str = typer.Option(
+        None, "--fleet-names",
+        help=("(req: sync) Comma separated fleet names.")
     ),
     blocking: bool = typer.Option(
         False, "--blocking",
@@ -301,7 +301,7 @@ def byogs(
         dockerfile=docker_file,
         skip_build=skip_build,
         snapend_id=snapend_id,
-        fleet_name=fleet_name,
+        fleet_names=fleet_names,
         blocking=blocking
     )
     getattr(byogs_obj, subcommand.replace('-', '_'))()

{snapctl-0.41.2 → snapctl-0.42.0}/snapctl/utils/helper.py

@@ -20,7 +20,7 @@ def validate_api_key(base_url: str, api_key: Union[str, None]) -> bool:
     try:
         url = f"{base_url}/v1/snapser-api/validate"
         res = requests.get(
-            url, headers={'api-key': api_key},
+            url, json={'api_key': api_key},
             timeout=SERVER_CALL_TIMEOUT
         )
         if res.ok: