snapctl 0.4.5__tar.gz → 0.22.1__tar.gz

{snapctl-0.4.5 → snapctl-0.22.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: snapctl
-Version: 0.4.5
+Version: 0.22.1
 Summary: Snapser CLI Tool
 Author: Ajinkya Apte
 Author-email: aj@snapser.com
@@ -8,6 +8,7 @@ Requires-Python: >=3.10,<4.0
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Requires-Dist: configparser (>=6.0.0,<7.0.0)
 Requires-Dist: requests (>=2.28.2,<3.0.0)
 Requires-Dist: typer[all] (>=0.7.0,<0.8.0)
@@ -16,49 +17,92 @@ Description-Content-Type: text/markdown
 # Snapser CLI Tool
 
 ## Dependencies
-The Snapser CLI tool depends on Python 3.X and Pip. MacOS comes pre isntalled with Python. But
+
+The Snapser CLI tool depends on Python 3.X and Pip. MacOS comes pre installed with Python. But
 please make sure you are running Python 3.X. On Windows, you can download Python 3.X from the
-Windows store. Some of the commands also need `docker`.
+Windows store. Some of the commands also need docker.
 
 ## Installation
+
 Installing PIP on MacOS
-```bash
+
+```
 curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py
 python3 get-pip.py
 ```
 
 Installing PIP on Windows
-```bash
+
+```
 curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py
 python get-pip.py
 ```
 
 Once you have Python and Pip installed
-```bash
+
+```
 pip install --user snapctl
 ```
-If you also have Python 2.X on your machine, you may have to run instead
-```bash
+
+If you also have Python 2.X on your machine, you may have to run the following command instead
+
+```
 pip3 install --user snapctl
 ```
 
-**Important** Please verify that your python path has been added to $PATH
+<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>
 
 ## Upgrade
+
 Upgrade your snapctl version
-```bash
+
+```
 pip install --user snapctl --upgrade
 ```
 
 ## Setup
+
 ### Get your Snapser Access Key
-Log in to your Snapser account. Click on your user icon on the top right and select, User Settings.
-Under developer key tab you will be able to copy your Access Key.
+
+Log in to your Snapser account. Click on your user icon on the top right and select, User Account.
+In the left navigation click on **Developer** which will bring up your Personal API Key widget.
+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>
 
 ### Setup a local config
-Create a file named `~/.snapser/config`. Open it using the editor of your choice and replace <key> with your
-personal Snapser Access key. Save the file.
-```text
+
+You have three ways to pass the API key to Snapctl
+1. Pass it via a command line argument with every command
+2. Pass it via an environment variable
+3. Pass it via a config file
+
+#### Command line argument
+
+Every Snapser command can take a command line argument `--api-key <your_key>`. This will take precedence over
+other methods.
+
+#### Environment Variable
+
+You can set an Environment variable `SNAPSER_API_KEY=<your_key>` and then run your snapctl commands. This will
+be evaluated after verifying if there is any command line argument.
+
+#### Config file
+
+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.
+
+```
 [default]
 snapser_access_key = <key>
 ```
@@ -66,35 +110,34 @@ snapser_access_key = <key>
 Or you can run the following command
 
 on MacOSX
-```bash {{title: 'MacOSX'}}
+
+```
 # $your_api_key = Your Snapser developer key
 echo -e "[default]\nSNAPSER_API_KEY=$your_api_key" > ~/.snapser/config
 ```
+
 on Windows Powershell
-```bash {{title: 'Windows Powershell'}}
+
+```
 # $your_api_key = Your Snapser developer key
 echo "[default]
 SNAPSER_API_KEY=$your_api_key" | Out-File -encoding utf8 ~\.snapser\config
 ```
 
-
 ## Verify Snapctl installation
-```bash
+
+```
 snapctl --version
 ```
-You should see the latest snapctl version in the output
-
 
-## Supported commands
-Run the following to see the list of commands Snapser supports
-```bash
-snapctl --help
-```
+You should see the latest snapctl version in the output
 
 ## Advanced Setup
+
 Snapser by default supports access to multiple accounts. You can create multiple profiles in your Snapser config
-`~/.snapser/config`.
-```text
+**~/.snapser/config**.
+
+```
 [profile personal]
 snapser_access_key = <key>
 
@@ -102,33 +145,48 @@ snapser_access_key = <key>
 snapser_access_key = <key>
 
 ```
+
 You can then set an environment variable telling Snapser which profile you want to use.
-```bash
+
+```
 # Mac
 export SNAPSER_PROFILE="my_profile_name";
 
 ```
-```bash
+
+```
 # Windows
 setx SNAPSER_PROFILE="my_profile_name";
 
 ```
-Or you can pass `--profile my_profile_name` with every command to tell Snapser to use a particular profile.
 
+Or you can pass **--profile my_profile_name** with every command to tell Snapser to use a particular profile.
 
 ## Commands
 
+Run the following to see the list of commands Snapser supports
+
+```
+snapctl --help
+```
+
 ### BYO Snap - Bring your own Snap
+
 #### 1. byosnap help
+
 See all the supported commands
-```bash {{ title: 'Bring your own Snap - Help' }}
+
+```
 # Help for the byosnap command
 snapctl byosnap --help
 ```
 
 #### 2. byosnap create
-Ability to create a custom snap.
-```bash {{ title: 'Bring your own Snap - Create' }}
+
+Create a custom snap. Note that you will have to build, push and publish your snap image, for it to be useable
+in a Snapend.
+
+```
 # Help for the byosnap command
 snapctl byosnap create --help
 
@@ -144,41 +202,44 @@ snapctl byosnap create --help
 snapctl byosnap create $byosnap_sid --name "$name" --desc "$desc" --platform "$platform" --language "$language"
 ```
 
-#### 3. byosnap publish-image
-Ability to publish a custom snap code image.
-```bash {{ title: 'Bring your own Snap - Publish a new image' }}
+### 3. byosnap build
+
+Build your snap image
+
+```
 # Help for the byosnap command
-snapctl byosnap publish-image --help
+snapctl byosnap build --help
 
 # Publish a new image
 # $byosnap_sid = Snap ID for your snap
 # $image_tag = An image tag for your snap
 # $code_root_path = Local code path where your Dockerfile is present
 # Example:
-# snapctl byosnap publish-image byosnap-jinks-flask --tag my-first-image --path /Users/DevName/Development/SnapserEngine/jinks_flask
-snapctl byosnap publish-image $byosnap_sid --tag $image_tag --path $code_root_path
+# snapctl byosnap build byosnap-jinks-flask --tag my-first-image --path /Users/DevName/Development/SnapserEngine/jinks_flask
+snapctl byosnap build $byosnap_sid --tag $image_tag --path $code_root_path
 ```
 
-#### 4. byosnap publish-version
-Ability to publish a new version for your Snap.
-```bash {{ title: 'Bring your own Snap - Publish a new version' }}
+### 4. byosnap push
+
+Push your snap image to Snapser
+
+```
 # Help for the byosnap command
-snapctl byosnap publish-version --help
+snapctl byosnap push --help
 
 # Publish a new image
 # $byosnap_sid = Snap ID for your snap
 # $image_tag = An image tag for your snap
-# $prefix = Prefix for your snap Eg: /v1
-# $version = Semantic version for your snap Eg: v0.0.1
-# $ingress_port = Ingress port for your snap Eg: 5003
 # Example:
-# snapctl byosnap publish-image byosnap-jinks-flask --tag my-first-image --prefix /v1 --version v0.0.1 --http-port 5003
-snapctl byosnap publish-version $byosnap_sid --tag $image_tag --prefix $prefix --version $version --http-port $ingress_port
+# snapctl byosnap push byosnap-jinks-flask --tag my-first-image
+snapctl byosnap push $byosnap_sid --tag $image_tag
 ```
 
 #### 5. byosnap upload-docs
-Ability to upload swagger.json and README.md for you Snap
-```bash {{ title: 'Bring your own Game Server - Publish a new image' }}
+
+Upload swagger.json and README.md for you Snap
+
+```
 # Help for the byogs command
 snapctl byosnap upload-docs --help
 
@@ -191,17 +252,61 @@ snapctl byosnap upload-docs --help
 snapctl byosnap upload-docs $byogs_sid --tag $image_tag --path $code_root_path
 ```
 
+#### 6. byosnap publish-image
+
+Publish a custom snap code image. This command executes, `build`, `push` and `upload-docs` one
+after the other.
+
+```
+# Help for the byosnap command
+snapctl byosnap publish-image --help
+
+# Publish a new image
+# $byosnap_sid = Snap ID for your snap
+# $image_tag = An image tag for your snap
+# $code_root_path = Local code path where your Dockerfile is present
+# Example:
+# snapctl byosnap publish-image byosnap-jinks-flask --tag my-first-image --path /Users/DevName/Development/SnapserEngine/jinks_flask
+snapctl byosnap publish-image $byosnap_sid --tag $image_tag --path $code_root_path
+```
+
+#### 7. byosnap publish-version
+
+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.
+
+```
+# Help for the byosnap command
+snapctl byosnap publish-version --help
+
+# Publish a new image
+# $byosnap_sid = Snap ID for your snap
+# $image_tag = An image tag for your snap
+# $prefix = Prefix for your snap Eg: /v1
+# $version = Semantic version for your snap Eg: v0.0.1
+# $ingress_port = Ingress port for your snap Eg: 5003
+# Example:
+# snapctl byosnap publish-image byosnap-jinks-flask --tag my-first-image --prefix /v1 --version v0.0.1 --http-port 5003
+snapctl byosnap publish-version $byosnap_sid --tag $image_tag --prefix $prefix --version $version --http-port $ingress_port
+```
+
 ### BYO Game Server - Bring your own Game Server
+
 #### 1. byogs help
+
 See all the supported commands
-```bash {{ title: 'Bring your own Game Server - Help' }}
+
+```
 # Help for the byogs command
 snapctl byogs --help
 ```
 
 #### 2. byogs create
-Ability to create a custom game server.
-```bash {{ title: 'Bring your own Game Server - Create' }}
+
+Create a custom game server. Note that you will have to build, push and publish your game server image, for it to be useable
+in a Snapend fleet.
+
+```
 # Help for the byosnap command
 snapctl byogs create --help
 
@@ -217,9 +322,44 @@ snapctl byogs create --help
 snapctl byogs create $byogs_sid --name "$name" --desc "$desc" --platform "$platform" --language "$language"
 ```
 
-#### 3. byogs publish-image
-Ability to publish your custom game server image.
-```bash {{ title: 'Bring your own Game Server - Publish a new image' }}
+#### 3. byogs build
+
+Build your custom game server image.
+
+```
+# Help for the byogs command
+snapctl byogs build --help
+
+# Publish a new image
+# $byogs_sid = Game server ID for your snap
+# $image_tag = An image tag for your snap
+# $code_root_path = Local code path where your Dockerfile is present
+# Example:
+# snapctl byogs build byosnap-jinks-gs --tag my-first-image --path /Users/DevName/Development/SnapserEngine/jinks_flask
+snapctl byogs build $byogs_sid --tag $image_tag --path $code_root_path
+```
+
+#### 4. byogs push
+
+Push your custom game server image.
+
+```
+# Help for the byogs command
+snapctl byogs push --help
+
+# Publish a new image
+# $byogs_sid = Game server ID for your snap
+# $image_tag = An image tag for your snap
+# Example:
+# snapctl byogs push byosnap-jinks-gs --tag my-first-image
+snapctl byogs push $byogs_sid --tag $image_tag
+```
+
+#### 5. byogs publish-image
+
+Publish your custom game server image. This command executes, `build` and `push` one after the other.
+
+```
 # Help for the byogs command
 snapctl byogs publish-image --help
 
@@ -232,9 +372,12 @@ snapctl byogs publish-image --help
 snapctl byogs publish-image $byogs_sid --tag $image_tag --path $code_root_path
 ```
 
-#### 4. byogs publish-version
-Ability to publish a new version for your Game server.
-```bash {{ title: 'Bring your own Snap - Publish a new version' }}
+#### 6. byogs publish-version
+
+Publish a new version for your game server. Only after your game server version is published, you will be able
+to use it in your Snapend fleet. This command should be run after you `push` or `publish-image` commands.
+
+```
 # Help for the byogs command
 snapctl byogs publish-version --help
 
@@ -250,22 +393,27 @@ snapctl byogs publish-version $byogs_sid --tag $image_tag --prefix $prefix --ver
 ```
 
 ### Snapend
+
 #### 1. snapend help
+
 See all the supported commands
-```bash {{ title: 'Snapend - Help' }}
+
+```
 # Help for the byogs command
 snapctl snapend --help
 ```
 
 #### 2. Snapend Downloads
+
 Download SDKs and Protos for your Snapend
-```bash {{ title: 'Snapend - Downloads' }}
+
+```
 # Help for the byogs command
 snapctl snapend download --help
 
 # Download your Snapend SDK and Protos
 # $snapend_id = Cluster Id
-# $category = client-sdk, server-sdk, protos
+# $category = client-sdk, server-sdk, protos, admin-settings
 # $sdk_type = One of the supported SDK names:
 # client-sdk(unity, unreal, roblox, godot, cocos, ios-objc, ios-swift, android-java, android-kotlin, web-ts, web-js),
 # server-sdk(csharp, cpp, lua, ts, go, python, kotlin, java, c, node, js, perl, php, closure, ruby, rust),
@@ -276,8 +424,10 @@ snapctl snapend download $snapend_id --category $category --type $sdk_type
 ```
 
 #### 3. Update Snapend BYOSnap or BYOGs versions
+
 Update your BYOSnap or BYOGs versions for the Snapend
-```bash {{ title: 'Snapend - Update BYOSnap or BYOGs' }}
+
+```
 # Help for the byogs command
 snapctl snapend update --help
 
@@ -286,7 +436,7 @@ snapctl snapend update --help
 # $byosnaps = Comma separated list of BYOSnap ids and version.
 # $byogs = Comma separated list of BYOGs fleet name, id and version.
 # --blocking = (Optional) This makes sure the CLI waits till your Snapend is live.
-# Note atleast one of the two needs to be present
+# 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 byogs-fleet-one:gs-1:v0.0.1,my-fleet-two:gs-2:v0.0.4 --blocking
@@ -294,8 +444,10 @@ snapctl snapend update $snapend_id --byosnaps $byosnaps --byogs $byogs --blockin
 ```
 
 #### 4. Get the Snapend state
+
 Get the Snapend state
-```bash {{ title: 'Snapend - Get state' }}
+
+```
 # Help for the byogs command
 snapctl snapend state --help
 
@@ -306,4 +458,3 @@ snapctl snapend state --help
 snapctl snapend state $snapend_id
 ```
 
-