snapctl 0.38.1__py3-none-any.whl → 0.38.2__py3-none-any.whl

snapctl/config/constants.py

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

{snapctl-0.38.1.dist-info → snapctl-0.38.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: snapctl
-Version: 0.38.1
+Version: 0.38.2
 Summary: Snapser CLI Tool
 Author: Ajinkya Apte
 Author-email: aj@snapser.com
@@ -17,7 +17,10 @@ Requires-Dist: requests (>=2.28.2,<3.0.0)
 Requires-Dist: typer[all] (>=0.12.3,<0.13.0)
 Description-Content-Type: text/markdown
 
-# Snapser CLI Tool
+# Snapser CLI
+
+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
 
@@ -53,12 +56,10 @@ If you also have Python 2.X on your machine, you may have to run the following c
 pip3 install --user snapctl
 ```
 
-<Note>
-  After you install snapctl you may have to add the python bin folder to your
-  path. For example, on MacOSX this is usually **~/Library/Python/3.9/bin**. On
-  Windows this is usually
-  **C:\Users\username\AppData\Roaming\Python\Python39\Scripts**.
-</Note>
+**IMPORTANT**: After you install snapctl you may have to add the python bin folder to your
+path. For example, on MacOSX this is usually **~/Library/Python/3.9/bin**. On
+Windows this is usually
+**C:\Users\username\AppData\Roaming\Python\Python39\Scripts**.
 
 ## Upgrade
 
@@ -77,10 +78,8 @@ In the left navigation click on **Developer** which will bring up your Personal
 If you have not generated an API Key yet click on the **Generate** button to generate a new key.
 You can generate up to 3 API Keys per user account.
 
-<Note>
-  Please make sure you save your API key in a safe place. You will not be able
-  to see it again.
-</Note>
+**IMPORTANT**: Please make sure you save your API key in a safe place. You will not be able
+to see it again.
 
 ### Setup a local config
 
@@ -288,6 +287,9 @@ snapctl byosnap publish-image $byosnap_sid --tag $image_tag --skip-build
 Publish a new version for your Snap. Only after your Snap version is published, you will be able
 to use your snap in your Snapend. This command should be run after `push` or `publish-image` commands.
 
+IMPORTANT: You need to have $byosnapProfile to run this command. BYOSnap profile is a JSON configuration
+of your BYOSnap for the development, staging and production environments.
+
 ```
 # Help for the byosnap command
 snapctl byosnap publish-version --help
@@ -619,3 +621,93 @@ snapctl snapend state $snapend_id
 | 81         | Generate profile error                                   |
 | 82         | Generate credentials error                               |
 
+
+
+## CLI Return Codes
+
+| Error Code | Description                                              |
+|------------|----------------------------------------------------------|
+| 0          | Operation completed successfully                         |
+| 1          | General error                                            |
+| 2          | Input error                                              |
+
+### Configuration Errors
+
+| Error Code | Description                                              |
+|------------|----------------------------------------------------------|
+| 10         | Configuration incorrect                                  |
+| 11         | Configuration error                                      |
+| 12         | Dependency missing                                       |
+
+### BYOGS Errors
+
+| Error Code | Description                                              |
+|------------|----------------------------------------------------------|
+| 20         | Generic BYOGS error                                      |
+| 21         | BYOGS dependency missing                                 |
+| 22         | BYOGS ECR login error                                    |
+| 23         | BYOGS build error                                        |
+| 24         | BYOGS tag error                                          |
+| 25         | BYOGS publish error                                      |
+| 26         | BYOGS publish permission error                           |
+| 27         | BYOGS publish duplicate tag error                        |
+
+### BYOSNAP Errors
+
+| Error Code | Description                                              |
+|------------|----------------------------------------------------------|
+| 30         | Generic BYOSNAP error                                    |
+| 31         | BYOSNAP dependency missing                               |
+| 32         | BYOSNAP ECR login error                                  |
+| 33         | BYOSNAP build error                                      |
+| 34         | BYOSNAP tag error                                        |
+| 35         | BYOSNAP publish image error                              |
+| 36         | BYOSNAP publish image permission error                   |
+| 37         | BYOSNAP publish image duplicate tag error                |
+| 38         | BYOSNAP create error                                     |
+| 39         | BYOSNAP create permission error                          |
+| 40         | BYOSNAP create duplicate name error                      |
+| 41         | BYOSNAP publish version error                            |
+| 42         | BYOSNAP publish version permission error                 |
+| 43         | BYOSNAP publish version duplicate version error          |
+| 44         | BYOSNAP publish version duplicate tag error              |
+
+### Game Errors
+
+| Error Code | Description                                              |
+|------------|----------------------------------------------------------|
+| 50         | Generic game error                                       |
+| 51         | Game create error                                        |
+| 52         | Game create permission error                             |
+| 53         | Game create duplicate name error                         |
+| 54         | Game enumerate error                                     |
+
+### Snapend Errors
+
+| Error Code | Description                                              |
+|------------|----------------------------------------------------------|
+| 60         | Generic snapend error                                    |
+| 61         | Snapend enumerate error                                  |
+| 62         | Snapend clone error                                      |
+| 63         | Snapend clone server error                               |
+| 64         | Snapend clone timeout error                              |
+| 65         | Snapend apply error                                      |
+| 66         | Snapend apply server error                               |
+| 67         | Snapend apply timeout error                              |
+| 68         | Snapend promote error                                    |
+| 69         | Snapend promote server error                             |
+| 70         | Snapend promote timeout error                            |
+| 71         | Snapend download error                                   |
+| 72         | Snapend update error                                     |
+| 73         | Snapend update server error                              |
+| 74         | Snapend update timeout error                             |
+| 75         | Snapend state error                                      |
+
+### Generate Errors
+
+| Error Code | Description                                              |
+|------------|----------------------------------------------------------|
+| 80         | Generic generate error                                   |
+| 81         | Generate profile error                                   |
+| 82         | Generate credentials error                               |
+

{snapctl-0.38.1.dist-info → snapctl-0.38.2.dist-info}/RECORD

@@ -7,7 +7,7 @@ snapctl/commands/game.py,sha256=icAPD8derxtgXHZQvziHd1O8fwD5Kw7HFMA8yXOUSRQ,4344
 snapctl/commands/generate.py,sha256=7z4nyqDuAieFmIg-XVIri2xkXPpDJd0E3uKYIfQtBqE,7891
 snapctl/commands/snapend.py,sha256=wEeA9v0SCs0G2093wMIKVTQhPLCfx8i5Ladk9kMlSCM,30729
 snapctl/config/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-snapctl/config/constants.py,sha256=s26pXoQWuafLkvtFtOv5sBHrAsZjVO3MUsG3AA3JqGQ,2735
+snapctl/config/constants.py,sha256=aWcnMMYkcqcdzwMO0xFxWNMb8vgDcq67RljeEBG2skc,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
@@ -16,8 +16,8 @@ snapctl/types/definitions.py,sha256=EQzLeiXkJ8ISRlCqHMviNVsWWpmhWjpKaOBLdlvOTmY,
 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.1.dist-info/LICENSE,sha256=6AcXm54KFSpmUI1ji9NIBd4Xl-DtjTqiyjBzfVb_CEk,2804
-snapctl-0.38.1.dist-info/METADATA,sha256=HGOdEApmi0QmDIvWhSDUIO072EdxaOsGWzMO2eeoLJQ,21465
-snapctl-0.38.1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-snapctl-0.38.1.dist-info/entry_points.txt,sha256=tkKW9MzmFdRs6Bgkv29G78i9WEBK4WIOWunPfe3t2Wg,44
-snapctl-0.38.1.dist-info/RECORD,,
+snapctl-0.38.2.dist-info/LICENSE,sha256=6AcXm54KFSpmUI1ji9NIBd4Xl-DtjTqiyjBzfVb_CEk,2804
+snapctl-0.38.2.dist-info/METADATA,sha256=uVc7pb2IG5tqnxCrgo5CjpPdl7whZSCLAKxVJAKkFc0,26942
+snapctl-0.38.2.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+snapctl-0.38.2.dist-info/entry_points.txt,sha256=tkKW9MzmFdRs6Bgkv29G78i9WEBK4WIOWunPfe3t2Wg,44
+snapctl-0.38.2.dist-info/RECORD,,