snapctl 0.31.0__py3-none-any.whl → 0.31.1__py3-none-any.whl

snapctl/config/constants.py

@@ -2,13 +2,14 @@
 Constants used by snapctl
 """
 COMPANY_NAME = 'Snapser'
-VERSION = '0.31.0'
+VERSION = '0.31.1'
 CONFIG_FILE_MAC = '~/.snapser/config'
 CONFIG_FILE_WIN = '%homepath%\\.snapser\\config'
 
 DEFAULT_PROFILE = 'default'
 API_KEY = 'SNAPSER_API_KEY'
 URL_KEY = 'SNAPSER_URL_KEY'
+CONFIG_PATH_KEY = 'SNAPSER_CONFIG_PATH'
 SERVER_CALL_TIMEOUT = 30
 
 SNAPCTL_SUCCESS = 0

snapctl/main.py

@@ -13,7 +13,7 @@ from snapctl.commands.byogs import ByoGs
 from snapctl.commands.game import Game
 from snapctl.commands.snapend import Snapend
 from snapctl.config.constants import COMPANY_NAME, API_KEY, URL_KEY, CONFIG_FILE_MAC, \
-    CONFIG_FILE_WIN, DEFAULT_PROFILE, VERSION, SNAPCTL_SUCCESS, SNAPCTL_ERROR
+    CONFIG_FILE_WIN, DEFAULT_PROFILE, VERSION, SNAPCTL_SUCCESS, SNAPCTL_ERROR, CONFIG_PATH_KEY
 from snapctl.config.endpoints import END_POINTS
 from snapctl.config.hashes import CLIENT_SDK_TYPES, SERVER_SDK_TYPES, PROTOS_TYPES, SERVICE_IDS, \
     SNAPEND_MANIFEST_TYPES
@@ -50,22 +50,23 @@ def extract_config(extract_key: str, profile: str | None = None) -> object:
         'location': '',
         'value': None
     }
-    # Option 1
+    # Option 1 - Get the API Key from the environment variable
     env_api_key = os.getenv(extract_key)
     if env_api_key is not None:
         result['location'] = 'environment-variable'
         result['value'] = env_api_key
         return result
-    # Option 2
-    config_file_path: str = ''
-    encoding: str | None = None
-    if platform == 'win32':
-        config_file_path = os.path.expandvars(CONFIG_FILE_WIN)
-        encoding = "utf-8-sig"
-    else:
-        config_file_path = os.path.expanduser(CONFIG_FILE_MAC)
+    encoding: str | None = "utf-8-sig" if platform == 'win32' else None
+    # Option 2 - Get the API Key from CONFIG PATH environment variable
+    config_file_path: str | None = os.getenv(CONFIG_PATH_KEY)
+    # Option 3 - Get the API Key from the hardcoded config file we look for
+    if config_file_path is None:
+        if platform == 'win32':
+            config_file_path = os.path.expandvars(CONFIG_FILE_WIN)
+        else:
+            config_file_path = os.path.expanduser(CONFIG_FILE_MAC)
+    result['location'] = f'config-file:{config_file_path}'
     if os.path.isfile(config_file_path):
-        result['location'] = 'config-file'
         config = configparser.ConfigParser()
         config.read(config_file_path, encoding=encoding)
         config_profile: str = DEFAULT_PROFILE

{snapctl-0.31.0.dist-info → snapctl-0.31.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: snapctl
-Version: 0.31.0
+Version: 0.31.1
 Summary: Snapser CLI Tool
 Author: Ajinkya Apte
 Author-email: aj@snapser.com
@@ -101,7 +101,10 @@ be evaluated after verifying if there is any command line argument.
 
 Create a file named `~/.snapser/config`. Open it using the editor of your choice and replace with your
 personal Snapser Access key. Save the file. Advantage of using this method is you can use the `--profile`
-argument with your snapctl command to use different API keys.
+argument with your snapctl command to use different API keys. NOTE: You may want to pass your own path
+instead on relying on the default one the CLI looks for. You can do so by setting an environment
+variable `SNAPSER_CONFIG_PATH='<your_custom_path>'`. Doing this will make sure that the CLI tool
+will look for the config file at that path.
 
 ```
 [default]
@@ -523,9 +526,9 @@ snapctl snapend update --help
 # --blocking = (Optional) This makes sure the CLI waits till your Snapend is live.
 # Note at least one of the two needs to be present
 # Example:
-# snapctl snapend update gx5x6bc0 --byosnaps byosnap-service-1:v1.0.0,byosnap-service--2:v1.0.0 --byogs byogs-fleet-one:gs-1:v0.0.1,my-fleet-two:gs-2:v0.0.4
-# snapctl snapend update gx5x6bc0 --byosnaps byosnap-service-1:v1.0.0,byosnap-service--2:v1.0.0 --byogs fleet-one:v0.0.1,fleet-two:v0.0.4 --blocking
-snapctl snapend update $snapend_id --byosnaps $byosnaps --byogs $byogs --blocking
+# snapctl snapend update --snapend-id gx5x6bc0 --byosnaps byosnap-service-1:v1.0.0,byosnap-service--2:v1.0.0 --byogs byogs-fleet-one:gs-1:v0.0.1,my-fleet-two:gs-2:v0.0.4
+# snapctl snapend update --snapend-id gx5x6bc0 --byosnaps byosnap-service-1:v1.0.0,byosnap-service--2:v1.0.0 --byogs fleet-one:v0.0.1,fleet-two:v0.0.4 --blocking
+snapctl snapend update --snapend-id $snapend_id --byosnaps $byosnaps --byogs $byogs --blocking
 ```
 
 #### 6. Get the Snapend state

{snapctl-0.31.0.dist-info → snapctl-0.31.1.dist-info}/RECORD

@@ -6,16 +6,16 @@ snapctl/commands/byosnap.py,sha256=RQv3r30dkz8n1BgEnE-tAnAzPLoz-CLEQoiy1WKZQeg,2
 snapctl/commands/game.py,sha256=rnsTqrXavE5D-KULXkDBQ-PBI8sSKK4it3S_YMJfiUY,3633
 snapctl/commands/snapend.py,sha256=exMH-8lp9qUociAWHJS15xRr-MtCe1fjbQAQmgODNIw,26187
 snapctl/config/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-snapctl/config/constants.py,sha256=0XQxi_HgoQlhmxxfSFR0Zqu2OIVedIAZNKiDkKWmQOU,525
+snapctl/config/constants.py,sha256=iX5zkftpOqdGJWoCK8-zwP_Mz9GD3BU62DVKrzTygpw,565
 snapctl/config/endpoints.py,sha256=VAeOmx3k3ukB-9XuGI65KtCJwFK-KFgzor-UWE8JU0g,297
 snapctl/config/hashes.py,sha256=tb0ilslgYvI8L4IKeiMfz2qYRDcezat8tg8dPGqlbAU,3093
-snapctl/main.py,sha256=zw3A1c2z0US6l24y847bsG__e2fb1ftYAjttIwsGKOo,18845
+snapctl/main.py,sha256=QES1PqGgMWjKVcOdUA8b14KHweiE2iJigxKtaoJfBDw,19147
 snapctl/types/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 snapctl/types/definitions.py,sha256=rkRyTBHzeQtCt_uYObgYvL5txnVq8r_n5g4IUAq2FWc,233
 snapctl/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 snapctl/utils/echo.py,sha256=0nhWYDBQTfZGtl8EK21hJhj0now2rQmCT-yYMCKupy4,584
 snapctl/utils/helper.py,sha256=xasSsg-0DgHT-TWejh2IXW-s9AYntO1D2O6Uy6BQLcE,1381
-snapctl-0.31.0.dist-info/METADATA,sha256=zquisLiqsLYz-hQJG-Gob19JAOKUC7CyjWvdMse8hEo,16191
-snapctl-0.31.0.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
-snapctl-0.31.0.dist-info/entry_points.txt,sha256=tkKW9MzmFdRs6Bgkv29G78i9WEBK4WIOWunPfe3t2Wg,44
-snapctl-0.31.0.dist-info/RECORD,,
+snapctl-0.31.1.dist-info/METADATA,sha256=cIywFLCBwuCumEUspq8sf4qgNcsAcixFSIph1Wz0fvI,16509
+snapctl-0.31.1.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
+snapctl-0.31.1.dist-info/entry_points.txt,sha256=tkKW9MzmFdRs6Bgkv29G78i9WEBK4WIOWunPfe3t2Wg,44
+snapctl-0.31.1.dist-info/RECORD,,