snapctl 0.32.0__py3-none-any.whl → 0.32.2__py3-none-any.whl

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.

Files changed (16) hide show
  1. snapctl/commands/byogs.py +175 -181
  2. snapctl/commands/byosnap.py +378 -371
  3. snapctl/commands/game.py +63 -57
  4. snapctl/commands/generate.py +48 -32
  5. snapctl/commands/snapend.py +361 -281
  6. snapctl/config/constants.py +72 -8
  7. snapctl/main.py +100 -135
  8. snapctl/types/definitions.py +20 -4
  9. snapctl/utils/echo.py +10 -2
  10. snapctl/utils/helper.py +60 -3
  11. {snapctl-0.32.0.dist-info → snapctl-0.32.2.dist-info}/METADATA +120 -8
  12. snapctl-0.32.2.dist-info/RECORD +23 -0
  13. snapctl-0.32.0.dist-info/RECORD +0 -23
  14. {snapctl-0.32.0.dist-info → snapctl-0.32.2.dist-info}/LICENSE +0 -0
  15. {snapctl-0.32.0.dist-info → snapctl-0.32.2.dist-info}/WHEEL +0 -0
  16. {snapctl-0.32.0.dist-info → snapctl-0.32.2.dist-info}/entry_points.txt +0 -0
{snapctl-0.32.0.dist-info → snapctl-0.32.2.dist-info}/METADATA RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: snapctl
3
- Version: 0.32.0
3
+ Version: 0.32.2
4
4
  Summary: Snapser CLI Tool
5
5
  Author: Ajinkya Apte
6
6
  Author-email: aj@snapser.com
@@ -11,8 +11,10 @@ Classifier: Programming Language :: Python :: 3.11
11
11
  Classifier: Programming Language :: Python :: 3.12
12
12
  Requires-Dist: configparser (>=6.0.0,<7.0.0)
13
13
  Requires-Dist: pyfiglet (>=1.0.2,<2.0.0)
14
+ Requires-Dist: pytest (>=8.2.2,<9.0.0)
15
+ Requires-Dist: pytest-mock (>=3.14.0,<4.0.0)
14
16
  Requires-Dist: requests (>=2.28.2,<3.0.0)
15
- Requires-Dist: typer[all] (>=0.7.0,<0.8.0)
17
+ Requires-Dist: typer[all] (>=0.12.3,<0.13.0)
16
18
  Description-Content-Type: text/markdown
17
19
 
18
20
  # Snapser CLI Tool
@@ -175,6 +177,7 @@ snapctl --help
175
177
  ```
176
178
 
177
179
  ### BYO Snap - Bring your own Snap
180
+ Snapctl commands for your custom code
178
181
 
179
182
  #### 1. byosnap help
180
183
 
@@ -206,7 +209,7 @@ snapctl byosnap create --help
206
209
  snapctl byosnap create $byosnap_sid --name "$name" --desc "$desc" --platform "$platform" --language "$language"
207
210
  ```
208
211
 
209
- ### 3. byosnap build
212
+ #### 3. byosnap build
210
213
 
211
214
  Build your snap image
212
215
 
@@ -223,7 +226,7 @@ snapctl byosnap build --help
223
226
  snapctl byosnap build $byosnap_sid --tag $image_tag --path $code_root_path
224
227
  ```
225
228
 
226
- ### 4. byosnap push
229
+ #### 4. byosnap push
227
230
 
228
231
  Push your snap image to Snapser
229
232
 
@@ -289,12 +292,14 @@ snapctl byosnap publish-version --help
289
292
  # $prefix = Prefix for your snap Eg: /v1
290
293
  # $version = Semantic version for your snap Eg: v0.0.1
291
294
  # $ingress_port = Ingress port for your snap Eg: 5003
295
+ # $byosnap_profile = BYOSnap profile to configure dev, stage and prod settings for this snap. You can generate a base version of this file using the `snapctl generate byosnap` command
292
296
  # Example:
293
- # snapctl byosnap publish-image byosnap-jinks-flask --tag my-first-image --prefix /v1 --version v0.0.1 --http-port 5003
294
- snapctl byosnap publish-version $byosnap_sid --tag $image_tag --prefix $prefix --version $version --http-port $ingress_port
297
+ # snapctl byosnap publish-image byosnap-jinks-flask --tag my-first-image --prefix /v1 --version v0.0.1 --http-port 5003 --byosnap-profile /Users/DevName/Development/SnapserEngine/jinks_flask/snapser-byosnap-profile.json
298
+ snapctl byosnap publish-version $byosnap_sid --tag $image_tag --prefix $prefix --version $version --http-port $ingress_port --byosnap-profile $byosnap_profile
295
299
  ```
296
300
 
297
301
  ### BYO Game Server - Bring your own Game Server
302
+ Snapctl commands for your custom game server
298
303
 
299
304
  #### 1. byogs help
300
305
 
@@ -355,14 +360,15 @@ snapctl byogs publish --tag $image_tag --path $code_root_path
355
360
 
356
361
 
357
362
  ### Game
363
+ Snapctl commands for your game
358
364
 
359
- #### 1. snapend help
365
+ #### 1. game help
360
366
 
361
367
  See all the supported commands
362
368
 
363
369
  ```
364
370
  # Help for the byogs command
365
- snapctl snapend --help
371
+ snapctl game --help
366
372
  ```
367
373
 
368
374
  #### 2. Create a game
@@ -377,8 +383,26 @@ List all the games
377
383
  snapctl game enumerate
378
384
  ```
379
385
 
386
+ ### Generate
387
+ Generator tool to help generate base files to be used in other commands
388
+
389
+ #### 1. generate help
390
+ See all the supported commands
391
+ ```
392
+ # Help for the generate command
393
+ snapctl generate --help
394
+ ```
395
+
396
+ #### 2. BYOSnap Profile
397
+ Generate the base file for BYOSnap profile to be used in the `snapctl byosnap publish-version` command
398
+
399
+ ```
400
+ snapctl generate byosnap-profile --out-path $output_path
401
+
402
+ ```
380
403
 
381
404
  ### Snapend
405
+ Snapctl commands for your snapend
382
406
 
383
407
  #### 1. snapend help
384
408
 
@@ -486,3 +510,91 @@ snapctl snapend state --help
486
510
  snapctl snapend state $snapend_id
487
511
  ```
488
512
 
513
+ ## Error codes
514
+ ### CLI Return Codes
515
+
516
+ | Error Code | Description |
517
+ |------------|----------------------------------------------------------|
518
+ | 0 | Operation completed successfully |
519
+ | 1 | General error |
520
+ | 2 | Input error |
521
+
522
+ ### Configuration Errors
523
+
524
+ | Error Code | Description |
525
+ |------------|----------------------------------------------------------|
526
+ | 10 | Configuration incorrect |
527
+ | 11 | Configuration error |
528
+ | 12 | Dependency missing |
529
+
530
+ ### BYOGS Errors
531
+
532
+ | Error Code | Description |
533
+ |------------|----------------------------------------------------------|
534
+ | 20 | Generic BYOGS error |
535
+ | 21 | BYOGS dependency missing |
536
+ | 22 | BYOGS ECR login error |
537
+ | 23 | BYOGS build error |
538
+ | 24 | BYOGS tag error |
539
+ | 25 | BYOGS publish error |
540
+ | 26 | BYOGS publish permission error |
541
+ | 27 | BYOGS publish duplicate tag error |
542
+
543
+ ### BYOSNAP Errors
544
+
545
+ | Error Code | Description |
546
+ |------------|----------------------------------------------------------|
547
+ | 30 | Generic BYOSNAP error |
548
+ | 31 | BYOSNAP dependency missing |
549
+ | 32 | BYOSNAP ECR login error |
550
+ | 33 | BYOSNAP build error |
551
+ | 34 | BYOSNAP tag error |
552
+ | 35 | BYOSNAP publish image error |
553
+ | 36 | BYOSNAP publish image permission error |
554
+ | 37 | BYOSNAP publish image duplicate tag error |
555
+ | 38 | BYOSNAP create error |
556
+ | 39 | BYOSNAP create permission error |
557
+ | 40 | BYOSNAP create duplicate name error |
558
+ | 41 | BYOSNAP publish version error |
559
+ | 42 | BYOSNAP publish version permission error |
560
+ | 43 | BYOSNAP publish version duplicate version error |
561
+ | 44 | BYOSNAP publish version duplicate tag error |
562
+
563
+ ### Game Errors
564
+
565
+ | Error Code | Description |
566
+ |------------|----------------------------------------------------------|
567
+ | 50 | Generic game error |
568
+ | 51 | Game create error |
569
+ | 52 | Game create permission error |
570
+ | 53 | Game create duplicate name error |
571
+ | 54 | Game enumerate error |
572
+
573
+ ### Snapend Errors
574
+
575
+ | Error Code | Description |
576
+ |------------|----------------------------------------------------------|
577
+ | 60 | Generic snapend error |
578
+ | 61 | Snapend enumerate error |
579
+ | 62 | Snapend clone error |
580
+ | 63 | Snapend clone server error |
581
+ | 64 | Snapend clone timeout error |
582
+ | 65 | Snapend apply error |
583
+ | 66 | Snapend apply server error |
584
+ | 67 | Snapend apply timeout error |
585
+ | 68 | Snapend promote error |
586
+ | 69 | Snapend promote server error |
587
+ | 70 | Snapend promote timeout error |
588
+ | 71 | Snapend download error |
589
+ | 72 | Snapend update error |
590
+ | 73 | Snapend update server error |
591
+ | 74 | Snapend update timeout error |
592
+ | 75 | Snapend state error |
593
+
594
+ ### Generate Errors
595
+
596
+ | Error Code | Description |
597
+ |------------|----------------------------------------------------------|
598
+ | 80 | Generic generate error |
599
+ | 81 | Generate BYOSNAP profile error |
600
+
snapctl-0.32.2.dist-info/RECORD ADDED
@@ -0,0 +1,23 @@
1
+ snapctl/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
2
+ snapctl/__main__.py,sha256=43jKoTk8b85hk_MT6499N3ruHdEfM8WBImd_-3VzjI8,116
3
+ snapctl/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
4
+ snapctl/commands/byogs.py,sha256=To8R5JKgLSzvbnE2PAQt2FDf-PJdAFrr_K0ExxA0njs,12751
5
+ snapctl/commands/byosnap.py,sha256=mTrpp7WWSrCRgxcZmZRrv4PAn6U4bQhTDO9UqciZPNw,28223
6
+ snapctl/commands/game.py,sha256=7255xoGszkk2pPcc2sRJP98-3S0qfSKXFOl5CrsbCSY,4349
7
+ snapctl/commands/generate.py,sha256=IWOOEBMreFThRBbTuKkIBgSjWw9E00vMNxyetJBxWMA,3238
8
+ snapctl/commands/snapend.py,sha256=cxBMNMfXyQeLdg5NyKZ2ujjUG7zYxOgyjmeAoD27t7I,29922
9
+ snapctl/config/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
10
+ snapctl/config/constants.py,sha256=BPZhlb7JitrVYfUgSL8YM-Rdk8CLZNM82CMpBWe6RJ4,2703
11
+ snapctl/config/endpoints.py,sha256=VAeOmx3k3ukB-9XuGI65KtCJwFK-KFgzor-UWE8JU0g,297
12
+ snapctl/config/hashes.py,sha256=4yydu7uPRwNo72WcU_HWjoCLDluG7mLPGCWVUFFF-xU,3378
13
+ snapctl/main.py,sha256=NJ9YjfGv3PwIqJDGx3il2KnHmVjiPAFtxvZkJfI160A,18073
14
+ snapctl/types/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
15
+ snapctl/types/definitions.py,sha256=EQzLeiXkJ8ISRlCqHMviNVsWWpmhWjpKaOBLdlvOTmY,644
16
+ snapctl/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
17
+ snapctl/utils/echo.py,sha256=bvirxTlxv-EAwyf4FT0yAqY5fsevp3yimxKmgQV73Fc,941
18
+ snapctl/utils/helper.py,sha256=jPXQnSbdOnktJdLotBugdHfVwkap-5MoApOmhJ-AsqA,3287
19
+ snapctl-0.32.2.dist-info/LICENSE,sha256=6AcXm54KFSpmUI1ji9NIBd4Xl-DtjTqiyjBzfVb_CEk,2804
20
+ snapctl-0.32.2.dist-info/METADATA,sha256=JyR_UooIxgm35S8YPA6DgKgvvaXJLxJHRpEc0AXZRNw,20110
21
+ snapctl-0.32.2.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
22
+ snapctl-0.32.2.dist-info/entry_points.txt,sha256=tkKW9MzmFdRs6Bgkv29G78i9WEBK4WIOWunPfe3t2Wg,44
23
+ snapctl-0.32.2.dist-info/RECORD,,
snapctl-0.32.0.dist-info/RECORD DELETED
@@ -1,23 +0,0 @@
1
- snapctl/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
2
- snapctl/__main__.py,sha256=43jKoTk8b85hk_MT6499N3ruHdEfM8WBImd_-3VzjI8,116
3
- snapctl/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
4
- snapctl/commands/byogs.py,sha256=LxGKlvKsnt6YIVjgj8I-5ziwNuEysLx3lgH8voYgpS8,12610
5
- snapctl/commands/byosnap.py,sha256=mhCDzzHSVyYhA3h4BSdGbS3ph1KeK47S3LutnN3mIiE,26727
6
- snapctl/commands/game.py,sha256=rnsTqrXavE5D-KULXkDBQ-PBI8sSKK4it3S_YMJfiUY,3633
7
- snapctl/commands/generate.py,sha256=E-EIm9X4DqCLOfUxA-412moG9aliNcL4UuI8X_nf2yk,2438
8
- snapctl/commands/snapend.py,sha256=exMH-8lp9qUociAWHJS15xRr-MtCe1fjbQAQmgODNIw,26187
9
- snapctl/config/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
10
- snapctl/config/constants.py,sha256=_KnxkpD_VSBYj8Mtngc3p58gdq4f24H5kZJaBZd6lXI,565
11
- snapctl/config/endpoints.py,sha256=VAeOmx3k3ukB-9XuGI65KtCJwFK-KFgzor-UWE8JU0g,297
12
- snapctl/config/hashes.py,sha256=4yydu7uPRwNo72WcU_HWjoCLDluG7mLPGCWVUFFF-xU,3378
13
- snapctl/main.py,sha256=HR6EKtxAh1ekpBuS9ug_9h44J-RNOBLdOTDd0VFAyiw,19649
14
- snapctl/types/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
15
- snapctl/types/definitions.py,sha256=rkRyTBHzeQtCt_uYObgYvL5txnVq8r_n5g4IUAq2FWc,233
16
- snapctl/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
17
- snapctl/utils/echo.py,sha256=0nhWYDBQTfZGtl8EK21hJhj0now2rQmCT-yYMCKupy4,584
18
- snapctl/utils/helper.py,sha256=xasSsg-0DgHT-TWejh2IXW-s9AYntO1D2O6Uy6BQLcE,1381
19
- snapctl-0.32.0.dist-info/LICENSE,sha256=6AcXm54KFSpmUI1ji9NIBd4Xl-DtjTqiyjBzfVb_CEk,2804
20
- snapctl-0.32.0.dist-info/METADATA,sha256=_P_CjVusW-2d6b4ttg_nI7A9M1jMNpbikk46hPIjSCk,14113
21
- snapctl-0.32.0.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
22
- snapctl-0.32.0.dist-info/entry_points.txt,sha256=tkKW9MzmFdRs6Bgkv29G78i9WEBK4WIOWunPfe3t2Wg,44
23
- snapctl-0.32.0.dist-info/RECORD,,