snapctl 0.49.0__py3-none-any.whl → 0.49.2__py3-none-any.whl

snapctl/commands/byows.py

@@ -87,9 +87,8 @@ class Byows:
             info(line.decode().rstrip())
 
     @staticmethod
-    def _write_export_command_to_console(snap_ids, port):
+    def _get_export_commands(snap_ids, port):
         '''
-        TODO: This is not used anymore
         Generate export commands for the given snap IDs and port.
         '''
         env_vars = []
@@ -104,12 +103,10 @@ class Byows:
 
         if system == "Windows":
             # PowerShell syntax
-            return "; ".join([f'$env:{env_vars[i].replace("=", " = ")}; $env:{env_vars[i+1].replace("=", " = ")}'
-                              for i in range(0, len(env_vars), 2)])
+            return "; ".join([f'$env:{env_vars[i].replace("=", " = ")}' for i in range(len(env_vars))])
         else:
             # Linux or macOS bash/zsh syntax
-            return "export \\\n" + " \\\n".join([f"  {env_vars[i]} {env_vars[i+1]}"
-                                                for i in range(0, len(env_vars), 2)])
+            return "\n".join([f"{env_vars[i]}" for i in range(len(env_vars))])
 
     @staticmethod
     def _generate_env_file(snap_ids, port):
@@ -141,21 +138,6 @@ class Byows:
 
         return env_file
 
-    @staticmethod
-    def _generate_env(snap_ids, port):
-        '''
-        Generate environment variables for the given snap IDs and port.
-        '''
-        env_file = Byows._generate_env_file(snap_ids, port)
-        info(f"Environment variables written to {env_file}")
-        system = platform.system()
-        if system == "Windows":
-            info(
-                f"Run the following command to set them in your session:\n\n    . {env_file}\n")
-        else:
-            info(
-                f"Run the following command to set them in your shell:\n\n    source {env_file}\n")
-
     @staticmethod
     def _format_portal_http_error(msg, http_err, response):
         """
@@ -213,21 +195,19 @@ class Byows:
         with open(pub_file, 'w') as f:
             f.write(public_key)
 
-        # Let user know about the forwarding
-        # TODO: AJ, needs to be the proper base url
-        info(f"Forwarding {self.base_snapend_url}/{snapend_id}/v1/{snap_id}" +
-             f"-> http://localhost:{incoming_http}/*")
-        info(
-            f"Your BYOSnap HTTP server should listen on: localhost:{incoming_http}")
+        # Combine all the information into a single info() call
         info(
-            f"Connect to other snaps over HTTP on: localhost:{outgoing_http}")
-        Byows._generate_env(snap_ids, port)
-        info('Press <ctrl-c> to stop forwarding')
+            f"Forwarding {self.base_snapend_url}/{snapend_id}/v1/{snap_id} -> http://localhost:{incoming_http}/*\n"
+            f"Your BYOSnap HTTP server should listen on: localhost:{incoming_http}\n"
+            f"Connect to other snaps over HTTP on: localhost:{outgoing_http}\n"
+            f"Set the environment variables before starting your local server:\n\n"
+            f"{Byows._get_export_commands(snap_ids, port)}\n\n"
+            f"Run the following command to set them in your session:\n\n"
+            f"    source {Byows._generate_env_file(snap_ids, port)}\n\n"
+            f"Press <ctrl-c> to stop forwarding"
+        )
 
-        # TODO: ??? AJ get the ssh host for the current environ from BYOWS_SSH_HOSTS contact in endpoints.py
         ssh_addr = ssh_connect_addr
-        if not ssh_addr:
-            snapctl_error(message=f"{env} is missing or empty in BYOWS_SSH_HOSTS", code=SNAPCTL_INPUT_ERROR)
 
         # Extract the port from the ssh_addr if present, otherwise default to 22
         if ':' in ssh_addr:
@@ -239,6 +219,8 @@ class Byows:
 
         ssh_command = [
             'ssh',
+            '-q',
+            '-4', # use IPv4
             '-o', 'ServerAliveInterval=60',
             '-o', 'StrictHostKeyChecking=no',
             '-o', 'UserKnownHostsFile=/dev/null',
@@ -252,7 +234,6 @@ class Byows:
             ssh_command += ['-R', f'{reverse_grpc_port}:localhost:{incoming_grpc}']
         ssh_command += [ssh_host]
 
-        # print(f'Running SSH command: {ssh_command}')
         process = None
         try:
             process = subprocess.Popen(
@@ -349,8 +330,7 @@ class Byows:
             transient=True,
         )
         progress.start()
-        progress.add_task(
-            description='Setting up BYOWs port forward...', total=None)
+        progress.add_task(description='Setting up BYOWs port forward...', total=None)
         try:
             url = f"{self.base_url}/v1/snapser-api/byows/snapends/" + \
                 f"{self.snapend_id}/snaps/{self.byosnap_id}"
@@ -359,15 +339,14 @@ class Byows:
                 headers={'api-key': self.api_key},
                 json={
                     "snapend_id": self.snapend_id,
-                    "snap_id": self.byosnap_id
+                    "snap_id": self.byosnap_id,
+                    "internal_grpc_port": self.grpc_port,
                 },
                 timeout=SERVER_CALL_TIMEOUT
             )
             res.raise_for_status()
             response_json = res.json()
 
-            # For debugging
-            #print(f"BYOWS Response:\n{json.dumps(response_json, indent=2)}")
 
             if res.ok and 'workstationPort' in response_json and \
                'workstationReversePort' in response_json and \
@@ -383,6 +362,8 @@ class Byows:
 
                 outgoing_http_port = response_json['workstationPort']
 
+                progress.stop()
+
                 self._setup_port_forward(
                     response_json['proxyPrivateKey'],
                     response_json['proxyPublicKey'],

snapctl/config/constants.py

@@ -3,7 +3,7 @@ Constants used by snapctl
 """
 COMPANY_NAME = 'Snapser'
 VERSION_PREFIX = 'beta-'
-VERSION = '0.49.0'
+VERSION = '0.49.2'
 CONFIG_FILE_MAC = '~/.snapser/config'
 CONFIG_FILE_WIN = '%homepath%\\.snapser\\config'
 

snapctl/data/releases/beta-0.49.0.mdx

@@ -1,12 +1,9 @@
 ## beta-0.49.0
-##### May 9, 2025
+##### May 5, 2025
 
 ### Breaking Change
 1. Renamed SDK type `server` to `api-key` to be consistent with the Snapser Web app.
 
-### Features
-1. You can now download the new Omni SDK via Snapctl.
-
 ### Bug Fixes
 1. The `snapctl byosnap generate-profile` command was not working when outside the root snapctl folder. This is now fixed.
 2. The `snapctl release-notes` commands were not working when outside the root snapctl folder. This is now fixed.

snapctl/data/releases/beta-0.49.1.mdx

@@ -0,0 +1,6 @@
+## beta-0.49.1
+##### May 9, 2025
+
+### Features
+1. Bring your own workstation (BYOW) support - You can now connect your BYOSnap to a Snapend. Allowing you to debug and test your BYOSnap code locally.
+

snapctl/data/releases/beta-0.49.2.mdx

@@ -0,0 +1,6 @@
+## beta-0.49.2
+##### May 12, 2025
+
+### Bug Fixes
+1. Bring your own workstation (BYOW) - An issue with incoming gRPC connections not using the appropriate port has been fixed.
+

{snapctl-0.49.0.dist-info → snapctl-0.49.2.dist-info}/METADATA

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

{snapctl-0.49.0.dist-info → snapctl-0.49.2.dist-info}/RECORD

@@ -3,13 +3,13 @@ snapctl/__main__.py,sha256=43jKoTk8b85hk_MT6499N3ruHdEfM8WBImd_-3VzjI8,116
 snapctl/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 snapctl/commands/byogs.py,sha256=WumLZRriCVF0SSnMn8TUL--iWhh3Yub3yQ-jz30faI0,19486
 snapctl/commands/byosnap.py,sha256=9Xe75VAi-KPFALSleUyMJsrvDJEG6cxBiGiF267PSJA,76897
-snapctl/commands/byows.py,sha256=T6SjB0PpYDYDVDI6c3nhZ4dUY_TGQKbtzMmgqB6i6GM,16714
+snapctl/commands/byows.py,sha256=JMwrRtD5_NXXjN-eWimoIJleAYMWlxVnum8VkKR76ZU,15824
 snapctl/commands/game.py,sha256=lAABIWIibrwcqvpKvTy_7UzzLtbiP6gdk4_qPBHFKOI,5248
 snapctl/commands/generate.py,sha256=9-NlZVQllBT2LZT_t9S3ztwtHzTbM-C8_x0f6z70U3g,5606
 snapctl/commands/release_notes.py,sha256=QlhBlywLiRTKBs3SlaxHf-0E0OEU_47Xjld9gGtj4Zw,1943
 snapctl/commands/snapend.py,sha256=4hY4ffLtZ2mxbKRgwDPi8erc78nGl-6kxmCf56HODpk,39382
 snapctl/config/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-snapctl/config/constants.py,sha256=AZPwrRdh3rT4H7M08uI7PqOyUlm1yJS9rKX1PadoApA,3653
+snapctl/config/constants.py,sha256=ltJNuRZqE3zTkzS4-O5dB5fjuZVoOgY_84XvEixpGOU,3653
 snapctl/config/endpoints.py,sha256=jD0n5ocJBbIkrb97F2_r9hqAHzUuddAqzqqBAPUKDTI,477
 snapctl/config/hashes.py,sha256=3OKAyOxQPnn--_hvPIzFJnhC8NVfQK4WT-RH4PHEV1w,5242
 snapctl/data/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -24,15 +24,17 @@ snapctl/data/releases/beta-0.47.0.mdx,sha256=p-bp0NUVcSKELHXtHJaq884_O4yTZDTCUbW
 snapctl/data/releases/beta-0.47.1.mdx,sha256=YqQ7ncHDW9pCbQNnQic1o_xQt3DinOFEo3YW0hJVUAk,645
 snapctl/data/releases/beta-0.47.2.mdx,sha256=9FQuJj6ntu0gG5Mf-d8lgCRqmzkuFyESqI_Gf5jLNmo,135
 snapctl/data/releases/beta-0.48.0.mdx,sha256=b9Dz-a2FAaZx2BnFTyle7PgJ2RuNv6Zj1KsT2TfaNH8,1244
-snapctl/data/releases/beta-0.49.0.mdx,sha256=U0GvmiwJFfhJWihyNGHY4p-cgqc0OFldfS9qg2fvhaA,459
+snapctl/data/releases/beta-0.49.0.mdx,sha256=pqJP7NfM3ZMxs4SoeANCdDqTxjR9IBGbBI3ThKTEbpw,391
+snapctl/data/releases/beta-0.49.1.mdx,sha256=4EXupEegYffnL5bu_XWxGbzIPp9xOzl7t4xbmhq52fU,200
+snapctl/data/releases/beta-0.49.2.mdx,sha256=Vv_OIQyPieEGI9FgTUT0v5Gm0PC2JWa2FqcCUhnvx6s,176
 snapctl/main.py,sha256=TT3osIBAJJLYERevPSNt-OxLwF0Rsxxu3GMzu72niPM,25203
 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=7ugGs1GE7Rywf1-tQxrgqXUU97EQYFjS3JUDpk9SX_Q,6850
-snapctl-0.49.0.dist-info/LICENSE,sha256=6AcXm54KFSpmUI1ji9NIBd4Xl-DtjTqiyjBzfVb_CEk,2804
-snapctl-0.49.0.dist-info/METADATA,sha256=1ALedesLOoQ31uxMWipWlL9W8kagIgCK_hqY8FwOs74,35965
-snapctl-0.49.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-snapctl-0.49.0.dist-info/entry_points.txt,sha256=tkKW9MzmFdRs6Bgkv29G78i9WEBK4WIOWunPfe3t2Wg,44
-snapctl-0.49.0.dist-info/RECORD,,
+snapctl-0.49.2.dist-info/LICENSE,sha256=6AcXm54KFSpmUI1ji9NIBd4Xl-DtjTqiyjBzfVb_CEk,2804
+snapctl-0.49.2.dist-info/METADATA,sha256=VSxYtNdGK73ALZE0d_ROoWDDdVmZFGgfealw4xn7BRc,35965
+snapctl-0.49.2.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+snapctl-0.49.2.dist-info/entry_points.txt,sha256=tkKW9MzmFdRs6Bgkv29G78i9WEBK4WIOWunPfe3t2Wg,44
+snapctl-0.49.2.dist-info/RECORD,,