snapctl 0.38.1__tar.gz → 0.38.2__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of snapctl might be problematic. Click here for more details.
- {snapctl-0.38.1 → snapctl-0.38.2}/PKG-INFO +104 -12
- {snapctl-0.38.1 → snapctl-0.38.2}/README.md +103 -11
- {snapctl-0.38.1 → snapctl-0.38.2}/pyproject.toml +1 -1
- {snapctl-0.38.1 → snapctl-0.38.2}/snapctl/config/constants.py +1 -1
- {snapctl-0.38.1 → snapctl-0.38.2}/LICENSE +0 -0
- {snapctl-0.38.1 → snapctl-0.38.2}/snapctl/__init__.py +0 -0
- {snapctl-0.38.1 → snapctl-0.38.2}/snapctl/__main__.py +0 -0
- {snapctl-0.38.1 → snapctl-0.38.2}/snapctl/commands/__init__.py +0 -0
- {snapctl-0.38.1 → snapctl-0.38.2}/snapctl/commands/byogs.py +0 -0
- {snapctl-0.38.1 → snapctl-0.38.2}/snapctl/commands/byosnap.py +0 -0
- {snapctl-0.38.1 → snapctl-0.38.2}/snapctl/commands/game.py +0 -0
- {snapctl-0.38.1 → snapctl-0.38.2}/snapctl/commands/generate.py +0 -0
- {snapctl-0.38.1 → snapctl-0.38.2}/snapctl/commands/snapend.py +0 -0
- {snapctl-0.38.1 → snapctl-0.38.2}/snapctl/config/__init__.py +0 -0
- {snapctl-0.38.1 → snapctl-0.38.2}/snapctl/config/endpoints.py +0 -0
- {snapctl-0.38.1 → snapctl-0.38.2}/snapctl/config/hashes.py +0 -0
- {snapctl-0.38.1 → snapctl-0.38.2}/snapctl/main.py +0 -0
- {snapctl-0.38.1 → snapctl-0.38.2}/snapctl/types/__init__.py +0 -0
- {snapctl-0.38.1 → snapctl-0.38.2}/snapctl/types/definitions.py +0 -0
- {snapctl-0.38.1 → snapctl-0.38.2}/snapctl/utils/__init__.py +0 -0
- {snapctl-0.38.1 → snapctl-0.38.2}/snapctl/utils/echo.py +0 -0
- {snapctl-0.38.1 → snapctl-0.38.2}/snapctl/utils/helper.py +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.1
|
|
2
2
|
Name: snapctl
|
|
3
|
-
Version: 0.38.
|
|
3
|
+
Version: 0.38.2
|
|
4
4
|
Summary: Snapser CLI Tool
|
|
5
5
|
Author: Ajinkya Apte
|
|
6
6
|
Author-email: aj@snapser.com
|
|
@@ -17,7 +17,10 @@ Requires-Dist: requests (>=2.28.2,<3.0.0)
|
|
|
17
17
|
Requires-Dist: typer[all] (>=0.12.3,<0.13.0)
|
|
18
18
|
Description-Content-Type: text/markdown
|
|
19
19
|
|
|
20
|
-
# Snapser CLI
|
|
20
|
+
# Snapser CLI
|
|
21
|
+
|
|
22
|
+
Snapser has developed a CLI tool called **snapctl** that can be used on MaxOSX, Linux and Windows machines.
|
|
23
|
+
Snapctl will be the best way for game studios to integrate Snapser into their build pipelines.
|
|
21
24
|
|
|
22
25
|
## Dependencies
|
|
23
26
|
|
|
@@ -53,12 +56,10 @@ If you also have Python 2.X on your machine, you may have to run the following c
|
|
|
53
56
|
pip3 install --user snapctl
|
|
54
57
|
```
|
|
55
58
|
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
**C:\Users\username\AppData\Roaming\Python\Python39\Scripts**.
|
|
61
|
-
</Note>
|
|
59
|
+
**IMPORTANT**: After you install snapctl you may have to add the python bin folder to your
|
|
60
|
+
path. For example, on MacOSX this is usually **~/Library/Python/3.9/bin**. On
|
|
61
|
+
Windows this is usually
|
|
62
|
+
**C:\Users\username\AppData\Roaming\Python\Python39\Scripts**.
|
|
62
63
|
|
|
63
64
|
## Upgrade
|
|
64
65
|
|
|
@@ -77,10 +78,8 @@ In the left navigation click on **Developer** which will bring up your Personal
|
|
|
77
78
|
If you have not generated an API Key yet click on the **Generate** button to generate a new key.
|
|
78
79
|
You can generate up to 3 API Keys per user account.
|
|
79
80
|
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
to see it again.
|
|
83
|
-
</Note>
|
|
81
|
+
**IMPORTANT**: Please make sure you save your API key in a safe place. You will not be able
|
|
82
|
+
to see it again.
|
|
84
83
|
|
|
85
84
|
### Setup a local config
|
|
86
85
|
|
|
@@ -288,6 +287,9 @@ snapctl byosnap publish-image $byosnap_sid --tag $image_tag --skip-build
|
|
|
288
287
|
Publish a new version for your Snap. Only after your Snap version is published, you will be able
|
|
289
288
|
to use your snap in your Snapend. This command should be run after `push` or `publish-image` commands.
|
|
290
289
|
|
|
290
|
+
IMPORTANT: You need to have $byosnapProfile to run this command. BYOSnap profile is a JSON configuration
|
|
291
|
+
of your BYOSnap for the development, staging and production environments.
|
|
292
|
+
|
|
291
293
|
```
|
|
292
294
|
# Help for the byosnap command
|
|
293
295
|
snapctl byosnap publish-version --help
|
|
@@ -619,3 +621,93 @@ snapctl snapend state $snapend_id
|
|
|
619
621
|
| 81 | Generate profile error |
|
|
620
622
|
| 82 | Generate credentials error |
|
|
621
623
|
|
|
624
|
+
|
|
625
|
+
|
|
626
|
+
## CLI Return Codes
|
|
627
|
+
|
|
628
|
+
| Error Code | Description |
|
|
629
|
+
|------------|----------------------------------------------------------|
|
|
630
|
+
| 0 | Operation completed successfully |
|
|
631
|
+
| 1 | General error |
|
|
632
|
+
| 2 | Input error |
|
|
633
|
+
|
|
634
|
+
### Configuration Errors
|
|
635
|
+
|
|
636
|
+
| Error Code | Description |
|
|
637
|
+
|------------|----------------------------------------------------------|
|
|
638
|
+
| 10 | Configuration incorrect |
|
|
639
|
+
| 11 | Configuration error |
|
|
640
|
+
| 12 | Dependency missing |
|
|
641
|
+
|
|
642
|
+
### BYOGS Errors
|
|
643
|
+
|
|
644
|
+
| Error Code | Description |
|
|
645
|
+
|------------|----------------------------------------------------------|
|
|
646
|
+
| 20 | Generic BYOGS error |
|
|
647
|
+
| 21 | BYOGS dependency missing |
|
|
648
|
+
| 22 | BYOGS ECR login error |
|
|
649
|
+
| 23 | BYOGS build error |
|
|
650
|
+
| 24 | BYOGS tag error |
|
|
651
|
+
| 25 | BYOGS publish error |
|
|
652
|
+
| 26 | BYOGS publish permission error |
|
|
653
|
+
| 27 | BYOGS publish duplicate tag error |
|
|
654
|
+
|
|
655
|
+
### BYOSNAP Errors
|
|
656
|
+
|
|
657
|
+
| Error Code | Description |
|
|
658
|
+
|------------|----------------------------------------------------------|
|
|
659
|
+
| 30 | Generic BYOSNAP error |
|
|
660
|
+
| 31 | BYOSNAP dependency missing |
|
|
661
|
+
| 32 | BYOSNAP ECR login error |
|
|
662
|
+
| 33 | BYOSNAP build error |
|
|
663
|
+
| 34 | BYOSNAP tag error |
|
|
664
|
+
| 35 | BYOSNAP publish image error |
|
|
665
|
+
| 36 | BYOSNAP publish image permission error |
|
|
666
|
+
| 37 | BYOSNAP publish image duplicate tag error |
|
|
667
|
+
| 38 | BYOSNAP create error |
|
|
668
|
+
| 39 | BYOSNAP create permission error |
|
|
669
|
+
| 40 | BYOSNAP create duplicate name error |
|
|
670
|
+
| 41 | BYOSNAP publish version error |
|
|
671
|
+
| 42 | BYOSNAP publish version permission error |
|
|
672
|
+
| 43 | BYOSNAP publish version duplicate version error |
|
|
673
|
+
| 44 | BYOSNAP publish version duplicate tag error |
|
|
674
|
+
|
|
675
|
+
### Game Errors
|
|
676
|
+
|
|
677
|
+
| Error Code | Description |
|
|
678
|
+
|------------|----------------------------------------------------------|
|
|
679
|
+
| 50 | Generic game error |
|
|
680
|
+
| 51 | Game create error |
|
|
681
|
+
| 52 | Game create permission error |
|
|
682
|
+
| 53 | Game create duplicate name error |
|
|
683
|
+
| 54 | Game enumerate error |
|
|
684
|
+
|
|
685
|
+
### Snapend Errors
|
|
686
|
+
|
|
687
|
+
| Error Code | Description |
|
|
688
|
+
|------------|----------------------------------------------------------|
|
|
689
|
+
| 60 | Generic snapend error |
|
|
690
|
+
| 61 | Snapend enumerate error |
|
|
691
|
+
| 62 | Snapend clone error |
|
|
692
|
+
| 63 | Snapend clone server error |
|
|
693
|
+
| 64 | Snapend clone timeout error |
|
|
694
|
+
| 65 | Snapend apply error |
|
|
695
|
+
| 66 | Snapend apply server error |
|
|
696
|
+
| 67 | Snapend apply timeout error |
|
|
697
|
+
| 68 | Snapend promote error |
|
|
698
|
+
| 69 | Snapend promote server error |
|
|
699
|
+
| 70 | Snapend promote timeout error |
|
|
700
|
+
| 71 | Snapend download error |
|
|
701
|
+
| 72 | Snapend update error |
|
|
702
|
+
| 73 | Snapend update server error |
|
|
703
|
+
| 74 | Snapend update timeout error |
|
|
704
|
+
| 75 | Snapend state error |
|
|
705
|
+
|
|
706
|
+
### Generate Errors
|
|
707
|
+
|
|
708
|
+
| Error Code | Description |
|
|
709
|
+
|------------|----------------------------------------------------------|
|
|
710
|
+
| 80 | Generic generate error |
|
|
711
|
+
| 81 | Generate profile error |
|
|
712
|
+
| 82 | Generate credentials error |
|
|
713
|
+
|
|
@@ -1,4 +1,7 @@
|
|
|
1
|
-
# Snapser CLI
|
|
1
|
+
# Snapser CLI
|
|
2
|
+
|
|
3
|
+
Snapser has developed a CLI tool called **snapctl** that can be used on MaxOSX, Linux and Windows machines.
|
|
4
|
+
Snapctl will be the best way for game studios to integrate Snapser into their build pipelines.
|
|
2
5
|
|
|
3
6
|
## Dependencies
|
|
4
7
|
|
|
@@ -34,12 +37,10 @@ If you also have Python 2.X on your machine, you may have to run the following c
|
|
|
34
37
|
pip3 install --user snapctl
|
|
35
38
|
```
|
|
36
39
|
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
**C:\Users\username\AppData\Roaming\Python\Python39\Scripts**.
|
|
42
|
-
</Note>
|
|
40
|
+
**IMPORTANT**: After you install snapctl you may have to add the python bin folder to your
|
|
41
|
+
path. For example, on MacOSX this is usually **~/Library/Python/3.9/bin**. On
|
|
42
|
+
Windows this is usually
|
|
43
|
+
**C:\Users\username\AppData\Roaming\Python\Python39\Scripts**.
|
|
43
44
|
|
|
44
45
|
## Upgrade
|
|
45
46
|
|
|
@@ -58,10 +59,8 @@ In the left navigation click on **Developer** which will bring up your Personal
|
|
|
58
59
|
If you have not generated an API Key yet click on the **Generate** button to generate a new key.
|
|
59
60
|
You can generate up to 3 API Keys per user account.
|
|
60
61
|
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
to see it again.
|
|
64
|
-
</Note>
|
|
62
|
+
**IMPORTANT**: Please make sure you save your API key in a safe place. You will not be able
|
|
63
|
+
to see it again.
|
|
65
64
|
|
|
66
65
|
### Setup a local config
|
|
67
66
|
|
|
@@ -269,6 +268,9 @@ snapctl byosnap publish-image $byosnap_sid --tag $image_tag --skip-build
|
|
|
269
268
|
Publish a new version for your Snap. Only after your Snap version is published, you will be able
|
|
270
269
|
to use your snap in your Snapend. This command should be run after `push` or `publish-image` commands.
|
|
271
270
|
|
|
271
|
+
IMPORTANT: You need to have $byosnapProfile to run this command. BYOSnap profile is a JSON configuration
|
|
272
|
+
of your BYOSnap for the development, staging and production environments.
|
|
273
|
+
|
|
272
274
|
```
|
|
273
275
|
# Help for the byosnap command
|
|
274
276
|
snapctl byosnap publish-version --help
|
|
@@ -599,3 +601,93 @@ snapctl snapend state $snapend_id
|
|
|
599
601
|
| 80 | Generic generate error |
|
|
600
602
|
| 81 | Generate profile error |
|
|
601
603
|
| 82 | Generate credentials error |
|
|
604
|
+
|
|
605
|
+
|
|
606
|
+
|
|
607
|
+
## CLI Return Codes
|
|
608
|
+
|
|
609
|
+
| Error Code | Description |
|
|
610
|
+
|------------|----------------------------------------------------------|
|
|
611
|
+
| 0 | Operation completed successfully |
|
|
612
|
+
| 1 | General error |
|
|
613
|
+
| 2 | Input error |
|
|
614
|
+
|
|
615
|
+
### Configuration Errors
|
|
616
|
+
|
|
617
|
+
| Error Code | Description |
|
|
618
|
+
|------------|----------------------------------------------------------|
|
|
619
|
+
| 10 | Configuration incorrect |
|
|
620
|
+
| 11 | Configuration error |
|
|
621
|
+
| 12 | Dependency missing |
|
|
622
|
+
|
|
623
|
+
### BYOGS Errors
|
|
624
|
+
|
|
625
|
+
| Error Code | Description |
|
|
626
|
+
|------------|----------------------------------------------------------|
|
|
627
|
+
| 20 | Generic BYOGS error |
|
|
628
|
+
| 21 | BYOGS dependency missing |
|
|
629
|
+
| 22 | BYOGS ECR login error |
|
|
630
|
+
| 23 | BYOGS build error |
|
|
631
|
+
| 24 | BYOGS tag error |
|
|
632
|
+
| 25 | BYOGS publish error |
|
|
633
|
+
| 26 | BYOGS publish permission error |
|
|
634
|
+
| 27 | BYOGS publish duplicate tag error |
|
|
635
|
+
|
|
636
|
+
### BYOSNAP Errors
|
|
637
|
+
|
|
638
|
+
| Error Code | Description |
|
|
639
|
+
|------------|----------------------------------------------------------|
|
|
640
|
+
| 30 | Generic BYOSNAP error |
|
|
641
|
+
| 31 | BYOSNAP dependency missing |
|
|
642
|
+
| 32 | BYOSNAP ECR login error |
|
|
643
|
+
| 33 | BYOSNAP build error |
|
|
644
|
+
| 34 | BYOSNAP tag error |
|
|
645
|
+
| 35 | BYOSNAP publish image error |
|
|
646
|
+
| 36 | BYOSNAP publish image permission error |
|
|
647
|
+
| 37 | BYOSNAP publish image duplicate tag error |
|
|
648
|
+
| 38 | BYOSNAP create error |
|
|
649
|
+
| 39 | BYOSNAP create permission error |
|
|
650
|
+
| 40 | BYOSNAP create duplicate name error |
|
|
651
|
+
| 41 | BYOSNAP publish version error |
|
|
652
|
+
| 42 | BYOSNAP publish version permission error |
|
|
653
|
+
| 43 | BYOSNAP publish version duplicate version error |
|
|
654
|
+
| 44 | BYOSNAP publish version duplicate tag error |
|
|
655
|
+
|
|
656
|
+
### Game Errors
|
|
657
|
+
|
|
658
|
+
| Error Code | Description |
|
|
659
|
+
|------------|----------------------------------------------------------|
|
|
660
|
+
| 50 | Generic game error |
|
|
661
|
+
| 51 | Game create error |
|
|
662
|
+
| 52 | Game create permission error |
|
|
663
|
+
| 53 | Game create duplicate name error |
|
|
664
|
+
| 54 | Game enumerate error |
|
|
665
|
+
|
|
666
|
+
### Snapend Errors
|
|
667
|
+
|
|
668
|
+
| Error Code | Description |
|
|
669
|
+
|------------|----------------------------------------------------------|
|
|
670
|
+
| 60 | Generic snapend error |
|
|
671
|
+
| 61 | Snapend enumerate error |
|
|
672
|
+
| 62 | Snapend clone error |
|
|
673
|
+
| 63 | Snapend clone server error |
|
|
674
|
+
| 64 | Snapend clone timeout error |
|
|
675
|
+
| 65 | Snapend apply error |
|
|
676
|
+
| 66 | Snapend apply server error |
|
|
677
|
+
| 67 | Snapend apply timeout error |
|
|
678
|
+
| 68 | Snapend promote error |
|
|
679
|
+
| 69 | Snapend promote server error |
|
|
680
|
+
| 70 | Snapend promote timeout error |
|
|
681
|
+
| 71 | Snapend download error |
|
|
682
|
+
| 72 | Snapend update error |
|
|
683
|
+
| 73 | Snapend update server error |
|
|
684
|
+
| 74 | Snapend update timeout error |
|
|
685
|
+
| 75 | Snapend state error |
|
|
686
|
+
|
|
687
|
+
### Generate Errors
|
|
688
|
+
|
|
689
|
+
| Error Code | Description |
|
|
690
|
+
|------------|----------------------------------------------------------|
|
|
691
|
+
| 80 | Generic generate error |
|
|
692
|
+
| 81 | Generate profile error |
|
|
693
|
+
| 82 | Generate credentials error |
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|