snapctl 0.44.1__py3-none-any.whl → 0.46.0__py3-none-any.whl

snapctl/data/profiles/snapser-byosnap-profile.json

@@ -0,0 +1,62 @@
+{
+    "name": "TODO: Add your BYOSnap name here. Name has to start with byosnap-. This is to ensure we avoid any collisions.",
+    "description": "TODO: Add your BYOSnap description here",
+    "platform": "TODO: Add your platform here. Options are 'linux/arm64' or 'linux/amd64'",
+    "language": "TODO: Add your language here. Options are 'go', 'node', 'python', 'java', 'csharp', 'cpp', 'rust', 'ruby', 'php', 'perl', 'clojure', 'lua', 'ts', 'js', 'kotlin', 'c'",
+    "prefix": "TODO: Add your prefix here. Prefix should start with / and only contain one path segment. Eg: '/v1'",
+    "ingress": {
+        "external_port": {
+            "name": "http",
+            "port": "TODO: Enter your external port here. Eg: 5003. Make sure it is a number and not a string."
+        },
+        "internal_ports": [
+            {
+                "name": "TODO: Optionally add your internal port name here. Eg: grpc. Names should be unique across the `ingress` dict. IMPORTANT: If you are not adding any internal ports, just keep `internal_ports: []`\",",
+                "port": "TODO: Optionally add your internal port here. Eg: 5004. Make sure it is a number and not a string. Port numbers should be unique across the `ingress` dict."
+            }
+        ]
+    },
+    "readiness_probe_config": {
+        "initial_delay_seconds": "TODO: Optionally add your readiness delay in seconds here. Eg: 5 or use null. Make sure it is a number and not a string.",
+        "path": "TODO: Optionally add your readiness path here. Eg: '/health' or use null"
+    },
+    "dev_template": {
+        "cpu": 100,
+        "memory": 0.125,
+        "min_replicas": 1,
+        "cmd": "",
+        "args": [],
+        "env_params": [
+            {
+                "key": "SNAPSER_ENVIRONMENT",
+                "value": "DEVELOPMENT"
+            }
+        ]
+    },
+    "stage_template": {
+        "cpu": 100,
+        "memory": 0.125,
+        "min_replicas": 1,
+        "cmd": "",
+        "args": [],
+        "env_params": [
+            {
+                "key": "SNAPSER_ENVIRONMENT",
+                "value": "STAGING"
+            }
+        ]
+    },
+    "prod_template": {
+        "cpu": 100,
+        "memory": 0.125,
+        "min_replicas": 2,
+        "cmd": "",
+        "args": [],
+        "env_params": [
+            {
+                "key": "SNAPSER_ENVIRONMENT",
+                "value": "PRODUCTION"
+            }
+        ]
+    }
+}

snapctl/data/profiles/snapser-byosnap-profile.yaml

@@ -0,0 +1,54 @@
+name: "My BYOSnap" # TODO: Add your BYOSnap name here.
+description: "Description" # TODO: Add your BYOSnap description here
+platform: "linux/arm64" # TODO: Add your platform here. Options are 'linux/arm64' or 'linux/amd64'
+language: "go" # TODO: Add your language here. Options are 'go', 'node', 'python', 'java', 'csharp', 'cpp', 'rust', 'ruby', 'php', 'perl', 'clojure', 'lua', 'ts', 'js', 'kotlin', 'c'
+prefix: "/v1" # TODO: Add your prefix here. Prefix should start with / and only contain one path segment. Eg: '/v1'
+ingress:
+  external_port:
+    name: http
+    port: 5003 # TODO: Enter your external port here. Eg: 5003. Make sure it is a number and not a string.
+  internal_ports: []
+  # Uncomment the section below if you need internal ports
+  # internal_ports:
+  #   - name: "grpc" # TODO: Optionally add your internal port name here. Eg: grpc. Names should be unique across the `ingress` dict. IMPORTANT: If you are not adding any internal ports, just keep `internal_ports: []`
+  #     port: 5004 # TODO: Optionally add your internal port here. Eg: 5004. Make sure it is a number and not a string. Port numbers should be unique across the `ingress` dict.
+readiness_probe_config:
+  initial_delay_seconds: null
+  path: null
+# Uncomment the section below if you need a readiness probe
+# readiness_probe_config:
+#   initial_delay_seconds: 5 # "TODO: Optionally add your readiness delay in seconds here. Eg: 5 or use null. Make sure it is a number and not a string."
+#   path: '/healthz' # "TODO: Optionally add your readiness path here. Eg: '/health' or use null"
+dev_template:
+  cpu: 100 # Options are [100, 250, 500, 750, 1000, 1500, 2000, 3000]
+  memory: 0.125 # Options are [0.125, 0.25, 0.5, 1, 2, 3, 4]
+  min_replicas: 1 # In Dev min_replicas should be 1
+  cmd: "" # TODO: Optionally add your dev command here. Eg: "python3 app.py" or use an empty string
+  args: [] # TODO: Optionally add your dev args here. Eg: ["--port", "5003"] or use an empty array
+  env_params: [] # TODO: Optionally add your dev env params here. Eg: [{"key": "SNAPSER_ENVIRONMENT", "value": "DEVELOPMENT"}] or use an empty array
+  # Uncomment the section below if you need dev env params
+  # env_params:
+  #   - key: SNAPSER_ENVIRONMENT
+  #     value: DEVELOPMENT
+stage_template:
+  cpu: 100 # Options are [100, 250, 500, 750, 1000, 1500, 2000, 3000]
+  memory: 0.125 # Options are [0.125, 0.25, 0.5, 1, 2, 3, 4]
+  min_replicas: 1 # In Staging min_replicas should be 1
+  cmd: "" # TODO: Optionally add your dev command here. Eg: "python3 app.py" or use an empty string
+  args: [] # TODO: Optionally add your dev args here. Eg: ["--port", "5003"] or use an empty array
+  env_params: [] # TODO: Optionally add your dev env params here. Eg: [{"key": "SNAPSER_ENVIRONMENT", "value": "STAGING"}] or use an empty array
+  # Uncomment the section below if you need dev env params
+  # env_params:
+  #   - key: SNAPSER_ENVIRONMENT
+  #     value: STAGING
+prod_template:
+  cpu: 100 # Options are [100, 250, 500, 750, 1000, 1500, 2000, 3000]
+  memory: 0.125 # Options are [0.125, 0.25, 0.5, 1, 2, 3, 4]
+  min_replicas: 1 # Options are [1, 2, 3, 4]
+  cmd: "" # TODO: Optionally add your dev command here. Eg: "python3 app.py" or use an empty string
+  args: [] # TODO: Optionally add your dev args here. Eg: ["--port", "5003"] or use an empty array
+  env_params: [] # TODO: Optionally add your dev env params here. Eg: [{"key": "SNAPSER_ENVIRONMENT", "value": "PRODUCTION"}] or use an empty array
+  # Uncomment the section below if you need dev env params
+  # env_params:
+  #   - key: SNAPSER_ENVIRONMENT
+  #     value: PRODUCTION

snapctl/data/releases/beta-0.46.0.mdx

@@ -0,0 +1,55 @@
+## beta-0.46.0
+##### Feb 14, 2025
+
+### Breaking Changes
+- **BYOSnap**:
+  - BYOSnap commands like `publish`, `sync` and `upload-docs` now take BYOSnap ID as a
+    non-positional argument. You now have to pass the BYOSnap Id using `--byosnap-id`.
+    ```bash
+    # Previously
+    snapctl byosnap publish byosnap-jinks-flask --version "v0.0.1" --path $path
+
+    # New
+    snapctl byosnap publish --byosnap-id byosnap-jinks-flask --version "v0.0.1" --path  $path
+    ```
+  - BYOSnap input parameter `--byosnap-profile-file` has been renamed to `--profile-filename`
+
+- **Generate**: The ability to generate a base BYOSnap profile using the `generate` command has
+  been deprecated. Instead its moved under `byosnap` commands for consistency.
+
+- **Snapend**:
+  - The manifest path variable has been changed for Snapend commands like `apply` and `clone`
+    from `--manifest-path` to `--manifest-path-filename`, for consistency with our new
+    variable naming nomenclature.
+  - The Snapend download command has new variable names like `format` and `type`. This is to add
+    more consistency and clarity to the command.
+    ```bash
+    # Previously
+    # snapctl snapend download --snapend-id gx5x6bc0 --category sdk --type unity --sdk-access-type external --sdk-auth-type user --out-path .
+
+    # New
+    snapctl snapend download --snapend-id gx5x6bc0 --category sdk --format unity --type user --out-path .
+    ```
+
+- Input param `--docker` for BYOGS and BYOSnap commands has been changed to `--docker_filename`
+
+### New Commands
+- **BYOSnap Generate Profile**: You can now use a new command to generate a base BYOSnap profile.
+  ```bash
+  snapctl byosnap generate-profile --out-path $outputPath --profile-filename $profileName
+  ```
+- **BYOSnap Validate Profile**: After you hand edit the base BYOSnap profile, you can use this
+  command to validate your BYOSnap profile before using it in other commands like `publish` and `sync`
+  ```bash
+  snapctl byosnap validate-profile --path $path --profile-filename $profileName
+  # or
+  snapctl byosnap validate-profile --resources-path $resources_path --profile-filename $profileName
+  ```
+- **Release Notes**: You can now view release notes for a specific version of Snapctl using the
+  `release-notes` command.
+  ```bash
+  snapctl release-notes releases
+  snapctl release-notes show
+  # or
+  snapctl release-notes show --version $version
+  ```

snapctl/main.py

@@ -13,9 +13,10 @@ from snapctl.commands.byogs import ByoGs
 from snapctl.commands.game import Game
 from snapctl.commands.generate import Generate
 from snapctl.commands.snapend import Snapend
+from snapctl.commands.release_notes import ReleaseNotes
 from snapctl.config.constants import COMPANY_NAME, API_KEY, URL_KEY, CONFIG_FILE_MAC, \
     CONFIG_FILE_WIN, DEFAULT_PROFILE, VERSION, SNAPCTL_SUCCESS, CONFIG_PATH_KEY, \
-    SNAPCTL_CONFIGURATION_INCORRECT
+    SNAPCTL_CONFIGURATION_INCORRECT, VERSION_PREFIX
 from snapctl.config.endpoints import END_POINTS
 from snapctl.config.hashes import PROTOS_TYPES, SERVICE_IDS, \
     SNAPEND_MANIFEST_TYPES, SDK_TYPES
@@ -224,7 +225,7 @@ def validate(
         None, "--api-key", help="API Key override.", callback=api_key_context_callback
     ),
     profile: Union[str, None] = typer.Option(
-        None, "--profile", help="Profile to use.", callback=profile_context_callback
+        None, "--profile", help="Profile from the Snapser config to use.", callback=profile_context_callback
     ),
 ) -> None:
     """
@@ -236,6 +237,34 @@ def validate(
     raise typer.Exit(code=SNAPCTL_SUCCESS)
 
 
+@app.command()
+def release_notes(
+    ctx: typer.Context,
+    subcommand: str = typer.Argument(
+        ..., help="Release Notes Subcommands: " + ", ".join(ReleaseNotes.SUBCOMMANDS) + "."
+    ),
+    version: str = typer.Option(
+        VERSION_PREFIX + VERSION, help="(optional: show-version) If not passed will show the latest version."
+    ),
+    api_key: Union[str, None] = typer.Option(
+        None, "--api-key", help="API Key override.", callback=api_key_context_callback
+    ),
+    profile: Union[str, None] = typer.Option(
+        None, "--profile", help="Profile from the Snapser config to use.", callback=profile_context_callback
+    ),
+) -> None:
+    """
+    Release notes for Snapctl
+    """
+    validate_command_context(ctx)
+    release_notes_obj: ReleaseNotes = ReleaseNotes(
+        subcommand=subcommand,
+        version=version
+    )
+    getattr(release_notes_obj, subcommand.replace('-', '_'))()
+    raise typer.Exit(code=SNAPCTL_SUCCESS)
+
+
 @app.command()
 def byogs(
     ctx: typer.Context,
@@ -243,10 +272,6 @@ def byogs(
     subcommand: str = typer.Argument(
         ..., help="BYOGs Subcommands: " + ", ".join(ByoGs.SUBCOMMANDS) + "."
     ),
-    # sid: str = typer.Argument(
-    #     ByoGs.SID,  help="Game Server Id. Should start with byogs"
-    # ),
-    # publish, publish-image and publish-version
     tag: str = typer.Option(
         None, "--tag",
         help="(req: build, push, publish) Tag for your snap"
@@ -258,7 +283,7 @@ def byogs(
     resources_path: Union[str, None] = typer.Option(
         None, "--resources-path", help="(optional: publish) Path to resources such as your Dockerfile, swagger.json or README.md"
     ),
-    docker_file: str = typer.Option(
+    docker_filename: str = typer.Option(
         "Dockerfile", help="(optional: publish) Dockerfile name to use"
     ),
     skip_build: bool = typer.Option(
@@ -284,7 +309,7 @@ def byogs(
         None, "--api-key", help="API Key override.", callback=api_key_context_callback
     ),
     profile: Union[str, None] = typer.Option(
-        None, "--profile", help="Profile to use.", callback=profile_context_callback
+        None, "--profile", help="Profile from the Snapser config to use.", callback=profile_context_callback
     ),
 ) -> None:
     """
@@ -298,7 +323,7 @@ def byogs(
         tag=tag,
         path=path,
         resources_path=resources_path,
-        dockerfile=docker_file,
+        docker_filename=docker_filename,
         skip_build=skip_build,
         snapend_id=snapend_id,
         fleet_names=fleet_names,
@@ -314,9 +339,11 @@ def byosnap(
     ctx: typer.Context,
     # Required fields
     subcommand: str = typer.Argument(
-        ..., help="BYOSnap Subcommands: " + ", ".join(ByoSnap.SUBCOMMANDS) + "."
+        ..., help="BYOSnap Subcommands: " + ", ".join(ByoSnap.SHOW_SUBCOMMANDS) + ". Commands to be deprecated soon: " + ", ".join(ByoSnap.TO_DEPRECATE_SUBCOMMANDS) + "."
+    ),
+    byosnap_id: Union[str, None] = typer.Option(
+        None, "--byosnap-id", help="(req: 'publish', 'sync', 'upload-docs', 'create', 'publish-image', 'publish-version', 'update-version') BYOSnap Id. Should start with byosnap-"
     ),
-    sid: str = typer.Argument(..., help="Snap Id. Should start with byosnap-"),
     # publish
     path: Union[str, None] = typer.Option(
         None, "--path", help="(req: publish, sync, publish-image, publish-version) Path to your snap code"
@@ -350,12 +377,12 @@ def byosnap(
     ),
     platform_type: str = typer.Option(
         None, "--platform",
-        help="(req: create) Platform for your snap - " + \
+        help="(req: create) Platform for your snap - " +
         ", ".join(ByoSnap.PLATFORMS) + "."
     ),
     language: str = typer.Option(
         None, "--language",
-        help="(req: create) Language of your snap - " + \
+        help="(req: create) Language of your snap - " +
         ", ".join(ByoSnap.LANGUAGES) + "."
     ),
     # publish-image and publish-version
@@ -368,17 +395,22 @@ def byosnap(
     skip_build: bool = typer.Option(
         False, "--skip-build", help="(optional: publish-image, sync) Skip the build step. You have to pass the image tag you used during the build step."
     ),
-    docker_file: str = typer.Option(
+    docker_filename: str = typer.Option(
         "Dockerfile", help="(optional override: publish, sync) Dockerfile name to use"
     ),
-    byosnap_profile_file: str = typer.Option(
-        "snapser-byosnap-profile.json", "--byosnap-profile-file", help="(optional override: publish, publish-version) BYOSnap Profile file name to use"
+    profile_filename: str = typer.Option(
+        "snapser-byosnap-profile.json", "--profile-filename", help="(req: generate-profile, validate-profile) (optional override: publish, publish-version) BYOSnap Profile is picked up via the --path or the --resources-path. This allows you to override the default profile filename."
+    ),
+    out_path: Union[str, None] = typer.Option(
+        None, "--out-path", help=(
+            "(req: generate-profile) Path to output the byosnap profile"
+        )
     ),
     api_key: Union[str, None] = typer.Option(
         None, "--api-key", help="(optional override) API Key override.", callback=api_key_context_callback
     ),
     profile: Union[str, None] = typer.Option(
-        None, "--profile", help="(optional override) Profile to use.", callback=profile_context_callback
+        None, "--profile", help="(optional override) Profile from the Snapser config to use.", callback=profile_context_callback
     ),
 ) -> None:
     """
@@ -389,7 +421,7 @@ def byosnap(
         subcommand=subcommand,
         base_url=ctx.obj['base_url'],
         api_key=ctx.obj['api_key'],
-        sid=sid,
+        byosnap_id=byosnap_id,
         name=name,
         desc=desc,
         platform_type=platform_type,
@@ -397,12 +429,13 @@ def byosnap(
         tag=tag,
         path=path,
         resources_path=resources_path,
-        docker_file=docker_file,
+        docker_filename=docker_filename,
         version=version,
         skip_build=skip_build,
         snapend_id=snapend_id,
         blocking=blocking,
-        byosnap_profile_file=byosnap_profile_file
+        profile_filename=profile_filename,
+        out_path=out_path
     )
     getattr(byosnap_obj, subcommand.replace('-', '_'))()
     success(f"BYOSnap {subcommand} complete")
@@ -426,7 +459,7 @@ def game(
         None, "--api-key", help="API Key override.", callback=api_key_context_callback
     ),
     profile: Union[str, None] = typer.Option(
-        None, "--profile", help="Profile to use.", callback=profile_context_callback
+        None, "--profile", help="Profile from the Snapser config to use.", callback=profile_context_callback
     ),
 ) -> None:
     """
@@ -450,26 +483,20 @@ def generate(
     # Required fields
     subcommand: str = typer.Argument(
         ..., help=(
-            "Generate Subcommands: " + \
-            ", ".join(Generate.SUBCOMMANDS) + "." + " "
-            "Deprecation Notice: " + \
-            ",".join(Generate.DEPRECATED_SOON_SUBCOMMANDS) + \
-            " will be deprecated soon. "
-            "Use `snapctl generate profile --category byosnap --out-path <output_path>` command instead."
+            "Generate Subcommands: " +
+            ", ".join(Generate.SUBCOMMANDS) + "."
         )
     ),
     category: Union[str, None] = typer.Option(
         None, "--category",
         help=(
-            "(req: profile, token) (profile: " +
-            ", ".join(Generate.CATEGORIES['profile']) +
-            ") (token: " + ", ".join(Generate.CATEGORIES['credentials']) + ')'
+            "(req: token) (token: " +
+              ", ".join(Generate.CATEGORIES['credentials']) + ')'
         )
     ),
-    # byosnap-profile, profile
     out_path: Union[str, None] = typer.Option(
         None, "--out-path", help=(
-            "(req: byosnap-profile, profile, token) Path to output the byosnap profile"
+            "(req: token) Path to output the byosnap profile"
         )
     ),
     # overrides
@@ -477,7 +504,7 @@ def generate(
         None, "--api-key", help="API Key override.", callback=api_key_context_callback
     ),
     profile: Union[str, None] = typer.Option(
-        None, "--profile", help="Profile to use.", callback=profile_context_callback
+        None, "--profile", help="Profile from the Snapser config to use.", callback=profile_context_callback
     ),
 ) -> None:
     """
@@ -514,9 +541,9 @@ def snapend(
         help="(req: enumerate, clone) Game Id"
     ),
     # apply, clone
-    manifest_path: str = typer.Option(
-        None, "--manifest-path",
-        help="(req: apply|clone) Path to the manifest file"
+    manifest_path_filename: str = typer.Option(
+        None, "--manifest-path-filename",
+        help="(req: apply|clone) Full Path to the manifest file including the filename."
     ),
     # download
     category: str = typer.Option(
@@ -526,35 +553,22 @@ def snapend(
             ", ".join(Snapend.DOWNLOAD_CATEGORY) + "."
         )
     ),
-    sdk_access_type: str = typer.Option(
-        'external', "--sdk-access-type",
+    category_format: str = typer.Option(
+        None, "--format",
         help=(
-            "(optional: download) Access type of the Download: " +
-            "external, internal."
-        )
-    ),
-    sdk_auth_type: str = typer.Option(
-        None, "--sdk-auth-type",
-        help=(
-            "(optional: download) Only applicable for --category sdk --sdk-access-type external "
-            "Auth-Types: (" + ", ".join(Snapend.AUTH_TYPES) + ")"
-        )
-    ),
-    platform_type: str = typer.Option(
-        None, "--type",
-        help=(
-            "(req: --category sdk|protos|snapend-manifest --type ) "
-            "SDK Types: sdk(" + ", ".join(SDK_TYPES.keys()) +
+            "(req: --category sdk|protos|snapend-manifest --format ) "
+            "SDK Formats: sdk(" + ", ".join(SDK_TYPES.keys()) +
             ") protos(" + ", ".join(PROTOS_TYPES.keys()) + ")" +
-            ") snapend-manifest(" + \
+            ") snapend-manifest(" +
             ", ".join(SNAPEND_MANIFEST_TYPES.keys()) + ")"
         )
     ),
-    protos_category: str = typer.Option(
-        'messages', "--protos-category",
+    category_type: str = typer.Option(
+        None, "--type",
         help=(
-            "(optional: download) Only applicable for --category protos --protos-category"
-            "Protos-Category: (" + ", ".join(Snapend.PROTOS_CATEGORY) + ")"
+            "(optional: download) Only applicable for --category sdk|protos --type"
+            "Sdk-types: (" + ", ".join(Snapend.CATEGORY_TYPE_SDK) + ")"
+            "Protos-types: (" + ", ".join(Snapend.CATEGORY_TYPE_PROTOS) + ")"
         )
     ),
     snaps: Union[str, None] = typer.Option(
@@ -587,8 +601,8 @@ def snapend(
     byogs_list: str = typer.Option(
         None, "--byogs",
         help=(
-            "(optional: update) Comma separated list of BYOGs fleet name:tags. "
-            "Eg: fleet-1:service-1:v1.0.0,fleet-2:service-2:v1.0.0"
+            "(optional: update) Comma separated list of BYOGs fleet_name:tag. "
+            "Eg: fleet-1:v1.0.0,fleet-2:v1.0.0"
         )
     ),
     # create, update, promote, apply, clone
@@ -604,7 +618,7 @@ def snapend(
         None, "--api-key", help="API Key override.", callback=api_key_context_callback
     ),
     profile: Union[str, None] = typer.Option(
-        None, "--profile", help="Profile to use.", callback=profile_context_callback
+        None, "--profile", help="Profile from the Snapser config to use.", callback=profile_context_callback
     ),
 ) -> None:
     """
@@ -621,11 +635,11 @@ def snapend(
         # Clone
         name=name, env=env,
         # Apply, Clone
-        manifest_path=manifest_path,
+        manifest_path_filename=manifest_path_filename,
         # Download
-        category=category, sdk_access_type=sdk_access_type,
-        sdk_auth_type=sdk_auth_type, platform_type=platform_type,
-        protos_category=protos_category,
+        category=category,
+        category_format=category_format,
+        category_type=category_type,
         snaps=snaps,
         # Download, Apply and Clone
         out_path=out_path,