snapctl 0.38.4__py3-none-any.whl → 0.39.0__py3-none-any.whl

snapctl/commands/byogs.py

@@ -33,7 +33,8 @@ class ByoGs:
 
     def __init__(
         self, subcommand: str, base_url: str, api_key: Union[str, None],
-        input_tag: Union[str, None], path: Union[str, None], dockerfile: str,
+        input_tag: Union[str, None], path: Union[str, None],
+        resources_path: Union[str, None], dockerfile: str,
         skip_build: bool = False
     ) -> None:
         self.subcommand: str = subcommand
@@ -50,6 +51,7 @@ class ByoGs:
             self.token) if self.token is not None else None
         self.input_tag: Union[str, None] = input_tag
         self.path: Union[str, None] = path
+        self.resources_path: Union[str, None] = resources_path
         self.dockerfile: str = dockerfile
         self.skip_build: bool = skip_build
         # Validate input
@@ -151,7 +153,12 @@ class ByoGs:
             if len(self.token_parts) == 4:
                 build_platform = self.token_parts[3]
             # Build your snap
-            docker_file_path = os.path.join(self.path, self.dockerfile)
+            if self.resources_path:
+                base_path = self.resources_path
+            else:
+                base_path = self.path
+            docker_file_path = os.path.join(base_path, self.dockerfile)
+
             # Warning check for architecture specific commands
             info(f'Building on system architecture {sys_platform.machine()}')
             check_response = check_dockerfile_architecture(
@@ -279,9 +286,16 @@ class ByoGs:
                 snapctl_error("Missing required parameter:  path",
                               SNAPCTL_INPUT_ERROR)
             # Check path
-            if not self.skip_build and not os.path.isfile(f"{self.path}/{self.dockerfile}"):
+            if self.resources_path:
+                docker_file_path = f"{self.resources_path}/{self.dockerfile}"
+            else:
+                docker_file_path = f"{self.path}/{self.dockerfile}"
+
+            if not self.skip_build and not os.path.isfile(docker_file_path):
                 snapctl_error(
-                    f"Unable to find {self.dockerfile} at path {self.path}", SNAPCTL_INPUT_ERROR)
+                    "Unable to find " +
+                    f"{self.dockerfile} at path {docker_file_path}",
+                    SNAPCTL_INPUT_ERROR)
         # elif self.subcommand == 'push':
         #     if not self.input_tag:
         #         error("Missing required parameter:  tag", SNAPCTL_INPUT_ERROR)

snapctl/commands/byosnap.py

@@ -49,10 +49,10 @@ class ByoSnap:
     def __init__(
         self, subcommand: str, base_url: str, api_key: Union[str, None], sid: str, name: str,
         desc: str, platform_type: str, language: str, input_tag: Union[str, None],
-        path: Union[str, None], dockerfile: str, prefix: str, version: Union[str, None],
-        http_port: Union[int, None], byosnap_profile: Union[str, None],
-        skip_build: bool = False, readiness_path: Union[str, None] = None,
-        readiness_delay: Union[int, None] = None
+        path: Union[str, None], resources_path: Union[str, None], dockerfile: str,
+        prefix: str, version: Union[str, None], http_port: Union[int, None],
+        byosnap_profile: Union[str, None], skip_build: bool = False,
+        readiness_path: Union[str, None] = None, readiness_delay: Union[int, None] = None
     ) -> None:
         self.subcommand: str = subcommand
         self.base_url: str = base_url
@@ -73,6 +73,7 @@ class ByoSnap:
             self.token) if self.token is not None else None
         self.input_tag: Union[str, None] = input_tag
         self.path: Union[str, None] = path
+        self.resources_path: Union[str, None] = resources_path
         self.dockerfile: str = dockerfile
         self.prefix: str = prefix
         self.version: Union[str, None] = version
@@ -185,7 +186,12 @@ class ByoSnap:
             description='Building your snap...', total=None)
         try:
             # Build your snap
-            docker_file_path = os.path.join(self.path, self.dockerfile)
+            if self.resources_path:
+                base_path = self.resources_path
+            else:
+                base_path = self.path
+            docker_file_path = os.path.join(base_path, self.dockerfile)
+
             # Warning check for architecture specific commands
             info(f'Building on system architecture {sys_platform.machine()}')
             check_response = check_dockerfile_architecture(
@@ -416,19 +422,24 @@ class ByoSnap:
                     snapctl_error("Missing required parameter: path",
                                   SNAPCTL_INPUT_ERROR)
                 # Check path
-                if not self.skip_build and not os.path.isfile(f"{self.path}/{self.dockerfile}"):
+                if self.resources_path:
+                    docker_file_path = f"{
+                        self.resources_path}/{self.dockerfile}"
+                else:
+                    docker_file_path = f"{self.path}/{self.dockerfile}"
+                if not self.skip_build and not os.path.isfile(docker_file_path):
                     snapctl_error(
-                        f"Unable to find " +
-                        f"{self.dockerfile} at path {self.path}",
+                        "Unable to find " +
+                        f"{self.dockerfile} at path {docker_file_path}",
                         SNAPCTL_INPUT_ERROR)
             # elif self.subcommand == 'push':
             #     if not self.input_tag:
             #         error("Missing required parameter: tag", SNAPCTL_INPUT_ERROR)
             #         raise typer.Exit(code=SNAPCTL_INPUT_ERROR)
             elif self.subcommand == 'upload-docs':
-                if self.path is None:
+                if self.path is None and self.resources_path is None:
                     snapctl_error(
-                        "Missing required parameter: path", SNAPCTL_INPUT_ERROR)
+                        "Missing one of: path or resources-path parameter", SNAPCTL_INPUT_ERROR)
             elif self.subcommand == 'publish-version':
                 if not self.input_tag:
                     snapctl_error(
@@ -516,8 +527,14 @@ class ByoSnap:
         progress.add_task(
             description='Uploading your BYOSnap Docs...', total=None)
         try:
-            swagger_file = os.path.join(self.path, 'swagger.json')
-            readme_file = os.path.join(self.path, 'README.md')
+            if self.resources_path:
+                base_dir = self.resources_path
+            else:
+                base_dir = self.path
+
+            swagger_file = os.path.join(base_dir, 'swagger.json')
+            readme_file = os.path.join(base_dir, 'README.md')
+
             if os.path.isfile(swagger_file):
                 # Push the swagger.json
                 try:
@@ -538,11 +555,11 @@ class ByoSnap:
                 except RequestException as e:
                     info(
                         'Exception: Unable to find swagger.json at ' +
-                        f'{self.path} {e}'
+                        f'{base_dir} {e}'
                     )
             else:
                 info(
-                    f'No swagger.json found at {self.path}' +
+                    f'No swagger.json found at {base_dir}' +
                     '. Skipping swagger.json upload'
                 )
 
@@ -567,11 +584,11 @@ class ByoSnap:
                 except RequestException as e:
                     info(
                         'Exception: Unable to find README.md at ' +
-                        f'{self.path} {str(e)}'
+                        f'{base_dir} {str(e)}'
                     )
             else:
                 info(
-                    f'No README.md found at {self.path}. Skipping README.md upload')
+                    f'No README.md found at {base_dir}. Skipping README.md upload')
         except RequestException as e:
             info(f'Exception: Unable to upload your API Json {str(e)}')
         finally:
@@ -648,7 +665,7 @@ class ByoSnap:
             info('--skip-build set. Skipping the build step.')
         self._docker_tag()
         self._docker_push()
-        if self.path is not None:
+        if self.path is not None or self.resources_path is not None:
             self.upload_docs()
         snapctl_success('BYOSNAP publish successful')
 

snapctl/config/constants.py

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

snapctl/main.py

@@ -255,8 +255,11 @@ def byogs(
     path: Union[str, None] = typer.Option(
         None, "--path", help="(req: 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"
+    ),
     docker_file: str = typer.Option(
-        "Dockerfile", help="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."
@@ -275,7 +278,7 @@ def byogs(
     validate_command_context(ctx)
     byogs_obj: ByoGs = ByoGs(
         subcommand, ctx.obj['base_url'], ctx.obj['api_key'],
-        tag, path, docker_file, skip_build
+        tag, path, resources_path, docker_file, skip_build
     )
     getattr(byogs_obj, subcommand.replace('-', '_'))()
     success(f"BYOGs {subcommand} complete")
@@ -317,8 +320,11 @@ def byosnap(
     path: Union[str, None] = typer.Option(
         None, "--path", help="(req: publish-image) Path to your snap code"
     ),
+    resources_path: Union[str, None] = typer.Option(
+        None, "--resources-path", help="(optional: publish-image, req: upload-docs) Path to resources such as your Dockerfile, swagger.json or README.md"
+    ),
     docker_file: str = typer.Option(
-        "Dockerfile", help="Dockerfile name to use"
+        "Dockerfile", help="(optional: publish) Dockerfile name to use"
     ),
     # publish-version
     prefix: str = typer.Option(
@@ -359,7 +365,7 @@ def byosnap(
     validate_command_context(ctx)
     byosnap_obj: ByoSnap = ByoSnap(
         subcommand, ctx.obj['base_url'], ctx.obj['api_key'], sid,
-        name, desc, platform_type, language, tag, path, docker_file,
+        name, desc, platform_type, language, tag, path, resources_path, docker_file,
         prefix, version, http_port, byosnap_profile, skip_build,
         readiness_path, readiness_delay
     )
@@ -448,7 +454,7 @@ def generate(
     raise typer.Exit(code=SNAPCTL_SUCCESS)
 
 
-@ app.command()
+@app.command()
 def snapend(
     ctx: typer.Context,
     # Required fields

{snapctl-0.38.4.dist-info → snapctl-0.39.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: snapctl
-Version: 0.38.4
+Version: 0.39.0
 Summary: Snapser CLI Tool
 Author: Ajinkya Apte
 Author-email: aj@snapser.com
@@ -220,9 +220,11 @@ snapctl byosnap build --help
 # $byosnap_sid = Snap ID for your snap
 # $image_tag = An image tag for your snap
 # $code_root_path = Local code path where your Dockerfile is present
+# $resources_path = Optional path to the resources directory in your Snap. This ensures, you are not forced to put the Dockerfile, swagger.json and README.md in the root directory of your Snap.
 # Example:
 # snapctl byosnap build byosnap-jinks-flask --tag my-first-image --path /Users/DevName/Development/SnapserEngine/jinks_flask
 snapctl byosnap build $byosnap_sid --tag $image_tag --path $code_root_path
+snapctl byosnap build $byosnap_sid --tag $image_tag --path $code_root_path --resources-path $resources_path
 ```
 
 #### 4. byosnap push
@@ -252,10 +254,10 @@ snapctl byosnap upload-docs --help
 # Publish a new image
 # $byosnap_sid = Snap ID for your snap
 # $image_tag = An image tag for your snap
-# $code_root_path = Local code path where your swagger.json and README.md files are present
+# $resources_path = Path to your swagger.json and README.md files
 # Example:
-# snapctl byosnap upload-docs byosnap-jinks-flask --tag my-first-image --path /Users/DevName/Development/SnapserEngine/jinks_flask
-snapctl byosnap upload-docs $byosnap_sid --tag $image_tag --path $code_root_path
+# snapctl byosnap upload-docs byosnap-jinks-flask --tag my-first-image --resources-path /Users/DevName/Development/SnapserEngine/jinks_flask
+snapctl byosnap upload-docs $byosnap_sid --tag $image_tag --resources-path $resources_path
 ```
 
 #### 6. byosnap publish-image
@@ -275,10 +277,12 @@ snapctl byosnap publish-image --help
 # $byosnap_sid = Snap ID for your snap
 # $image_tag = An image tag for your snap
 # $code_root_path = Local code path where your Dockerfile is present
+# $resources_path = Optional path to the resources directory in your Snap. This ensures, you are not forced to put the Dockerfile, swagger.json and README.md in the root directory of your Snap.
 # $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.
 # Example:
 # snapctl byosnap publish-image byosnap-jinks-flask --tag my-first-image --path /Users/DevName/Development/SnapserEngine/jinks_flask
 snapctl byosnap publish-image $byosnap_sid --tag $image_tag --path $code_root_path
+snapctl byosnap publish-image $byosnap_sid --tag $image_tag --path $code_root_path --resources-path $resources_path
 snapctl byosnap publish-image $byosnap_sid --tag $image_tag --skip-build
 ```
 
@@ -365,10 +369,12 @@ snapctl byogs publish --help
 # Publish a new image
 # $image_tag = An image tag for your snap
 # $code_root_path = Local code path where your Dockerfile is present
+# $resources_path = Optional path to the resources directory. This ensures, you are not forced to put the Dockerfile at the root directory of your Game Server code.
 # $skip-build = 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.
 # Example:
 # snapctl byogs publish --tag my-first-image --path /Users/DevName/Development/SnapserEngine/game_server
 snapctl byogs publish --tag $image_tag --path $code_root_path
+snapctl byogs publish --tag $image_tag --path $code_root_path --resources-path $resources_path
 snapctl byogs publish --tag $image_tag --skip-build
 ```
 

{snapctl-0.38.4.dist-info → snapctl-0.39.0.dist-info}/RECORD

@@ -1,23 +1,23 @@
 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=XdF8Eq8vDzKFZzQzeRAbApTK8HwXBGwe64lcWNBu-dQ,13515
-snapctl/commands/byosnap.py,sha256=Z-yf7ssdvUnycIcZDN1JXZ-CO5gjq6yQZ7_bb6KYAeQ,31207
+snapctl/commands/byogs.py,sha256=oKPRHMyA7gqfMHgAg5dEclJMNcNlDffaZI7EEhSWiaw,13998
+snapctl/commands/byosnap.py,sha256=yv7A_s26Znxyl6wRv85LbPXogs7eVEHOCdlaX_vMIvw,31893
 snapctl/commands/game.py,sha256=icAPD8derxtgXHZQvziHd1O8fwD5Kw7HFMA8yXOUSRQ,4344
 snapctl/commands/generate.py,sha256=7z4nyqDuAieFmIg-XVIri2xkXPpDJd0E3uKYIfQtBqE,7891
 snapctl/commands/snapend.py,sha256=aYKeBZNwDMGWPsYl4qOCkVsrotkE2vzUobfg8AkRetw,30741
 snapctl/config/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-snapctl/config/constants.py,sha256=sO4B9Ta7nth4_is9SmANoiX4QU6qyqPk74A5ckcKJ1Y,2735
+snapctl/config/constants.py,sha256=Kzd50iL81fkkTYHwSVtlewxnQdViZ9cQSbB3RO0IHVQ,2735
 snapctl/config/endpoints.py,sha256=VAeOmx3k3ukB-9XuGI65KtCJwFK-KFgzor-UWE8JU0g,297
 snapctl/config/hashes.py,sha256=7jkMYfMAcgdque5PN10-B3QqwoXvtsuJKJr9dKZUvJ8,4139
-snapctl/main.py,sha256=aaFB0insVsIKDp25Hc0J0t5JtIQJXxDgHbBwKaHVbBc,19619
+snapctl/main.py,sha256=XEpJSIkp3_ymemykN0Xevyu2B8xSDZuLgZU4RmEjUEg,20094
 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=XSn0x46mED86kQU1UlmuvJY9GsXO3Ncoba18Lb6FE8k,5522
-snapctl-0.38.4.dist-info/LICENSE,sha256=6AcXm54KFSpmUI1ji9NIBd4Xl-DtjTqiyjBzfVb_CEk,2804
-snapctl-0.38.4.dist-info/METADATA,sha256=zQvVPy5BjBaEdaBoLvm26e_PF7xLfTBoaq1i9qpBQ5s,21967
-snapctl-0.38.4.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-snapctl-0.38.4.dist-info/entry_points.txt,sha256=tkKW9MzmFdRs6Bgkv29G78i9WEBK4WIOWunPfe3t2Wg,44
-snapctl-0.38.4.dist-info/RECORD,,
+snapctl-0.39.0.dist-info/LICENSE,sha256=6AcXm54KFSpmUI1ji9NIBd4Xl-DtjTqiyjBzfVb_CEk,2804
+snapctl-0.39.0.dist-info/METADATA,sha256=wWAtfPxvfUX5R3NSEB8Wow2xhj8xOPH1uWf8K8l8fTo,22833
+snapctl-0.39.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+snapctl-0.39.0.dist-info/entry_points.txt,sha256=tkKW9MzmFdRs6Bgkv29G78i9WEBK4WIOWunPfe3t2Wg,44
+snapctl-0.39.0.dist-info/RECORD,,