wasm-action 0.0.1__py3-none-any.whl → 0.0.2__py3-none-any.whl

wasm_action/action.py

@@ -14,6 +14,7 @@ from . import warg_proto
 from .warg_crypto import PrivateKey
 from .warg_client import WargClient
 from .util import add_github_output, detect_registry_settings, RegistryType
+from .util import format_package, parse_package
 from .model import Action, RegistryType
 from .warg_pull import warg_pull
 
@@ -26,12 +27,6 @@ def cli():
     pass
 
 
-@cli.command(help="Validate action")
-@click.option('--action', required=True, help="requested action", type=Action)
-def action(action):
-    add_github_output('action', action.value)
-
-
 @cli.command(help="Push to a WebAssembly registry")
 @click.option('--registry', required=True, help="registry domain name")
 @click.option('--namespace', required=True, help="package namespace")
@@ -77,37 +72,32 @@ def push(registry, namespace, name, version, path):
 
 @cli.command(help="Pull from a WebAssembly registry")
 @click.option('--registry', required=True, help="registry domain name")
-@click.option('--namespace', required=True, help="package namespace")
-@click.option('--name', required=True, help="package name")
-@click.option('--version', required=False, help="requested package version")
+@click.option('--package', required=True, help="package spec")
 @click.option('--path', required=False, help="filename")
-def pull(registry, namespace, name, version=None, path=None):
-
-    if not namespace:
-        raise error('namespace is required')
+@click.option('--warg-token', required=False, envvar='WARG_TOKEN', help="warg token")
+def pull(registry, package, path=None, warg_token=None):
 
-    if not name:
-        raise error('name is required')
+    if not package:
+        raise error("package is required")
 
-    if version:
-        # validate version as semver
-        semver.Version.parse(version)
+    namespace, name, version = parse_package(package)
 
     settings = validate_registry(registry)
 
     if settings.get('registry-type') != RegistryType.WARG:
         raise error("Registry type not supported: {}".format(settings.get('registry-type')))
 
-    package = warg_pull(registry, settings['warg-url'], namespace, name, version)
+    download = warg_pull(registry, settings['warg-url'], namespace, name, version, warg_token=warg_token)
 
-    filename = path or "{}:{}@{}.wasm".format(namespace, name, package.version)
+    filename = path or "{}:{}@{}.wasm".format(namespace, name, download.version)
     with open(filename, 'wb') as f:
-        f.write(package.content)
+        f.write(download.content)
 
-    add_github_output('namespace', package.namespace)
-    add_github_output('name', package.name)
-    add_github_output('version', package.version)
-    add_github_output('digest', package.digest)
+    add_github_output('package', format_package(namespace=namespace, name=name, version=download.version))
+    add_github_output('package-namespace', download.namespace)
+    add_github_output('package-name', download.name)
+    add_github_output('package-version', download.version)
+    add_github_output('digest', download.digest)
     add_github_output('filename', filename)
 
 

wasm_action/util.py

@@ -1,7 +1,9 @@
 
 import os
+import re
 import sys
 import requests
+import semver
 
 from .model import RegistryType
 
@@ -60,7 +62,44 @@ def extract_version(filename):
 
 
 def format_package(namespace, name, version):
-	if version:
-		return "{}:{}@{}".format(namespace, name, version)
-	else:
-		return "{}:{}".format(namespace, name)
+    """Canonical package representation in namespace:name@version format"""
+    if version:
+        return "{}:{}@{}".format(namespace, name, version)
+    else:
+        return "{}:{}".format(namespace, name)
+
+
+def parse_package(package):
+    """Parse a package string.
+
+    The following forms are supported:
+        namespace:name
+        namespace:name@version
+        namespace/name
+        namespace/name@version
+
+    Returns a tuple (namespace, name, version)
+    """
+    left, version = package, None
+    if '@' in package:
+        left, version = package.split('@', 1)
+    if ':' in left:
+        namespace, name = left.split(':', 1)
+    elif '/' in left:
+        namespace, name = left.split('/', 1)
+    else:
+        namespace, name = None, left
+
+    if not namespace:
+        raise ValueError("package namespace is required")
+    if not name:
+        raise ValueError("package version is required")
+
+    if not re.match(r"[\w-]+", namespace):
+        raise ValueError("invalid package namespace")
+    if not re.match(r"[\w-]+", name):
+        raise ValueError("invalid package name")
+    if version:
+        # throws on failed validation
+        semver.Version.parse(version)
+    return namespace, name, version

wasm_action/warg_client.py

@@ -9,22 +9,27 @@ import warg_openapi as warg
 
 class WargClient:
 
-    def __init__(self, registry, warg_url, access_token=None):
+    def __init__(self, registry, warg_url, warg_token=None, stealth=False):
         self.registry = registry
 
         configuration = warg.Configuration(
             host = "{}{}".format(warg_url, 'v1' if warg_url.endswith('/') else '/v1'),
-            #access_token=access_token,
         )
 
         # Support for digest strings as path params: sha256:<digest>
         # or else they get quoted, resulting in "Invalid content digest" error.
         configuration.safe_chars_for_path_param = "/:"
 
-        client = warg.ApiClient(configuration=configuration)
+        client = warg.ApiClient(
+            configuration=configuration,
+        )
+
+        # private packages
+        if warg_token:
+            client.default_headers['Authorization'] = 'Bearer {}'.format(warg_token)
 
-        # stealth mode
-        # client.default_headers['User-Agent'] = urllib3.util.SKIP_HEADER
+        if stealth:
+            client.default_headers['User-Agent'] = urllib3.util.SKIP_HEADER
 
         self.fetch_api = warg.FetchApi(client)
         self.content_api = warg.ContentApi(client)

wasm_action/warg_crypto.py

@@ -50,7 +50,7 @@ class PrivateKey:
         key_bytes = base64.b64decode(key_b64)
         # todo: compare bytes length with curve key length
 
-        key_int = int.from_bytes(key_bytes)
+        key_int = int.from_bytes(key_bytes, byteorder='big')
         key = ec.derive_private_key(key_int, curve=curve)
         return cls(key)
 
@@ -81,7 +81,7 @@ class PrivateKey:
     def canonical(self):
         """Convert to `<algo>:<base64>` format."""
         key_int = self.key.private_numbers().private_value
-        key_bytes = key_int.to_bytes(length=32)
+        key_bytes = key_int.to_bytes(length=32, byteorder='big')
         key_b64 = base64.b64encode(key_bytes).decode('ascii')
         return "{}:{}".format('ecdsa-p256', key_b64)
 

wasm_action/warg_pull.py

@@ -14,12 +14,13 @@ def error(text):
     return ValueError(text)
 
 
-def warg_pull(registry, warg_url, namespace, name, version=None):
+def warg_pull(registry, warg_url, namespace, name, version=None, warg_token=None) -> PackageDownload:
 
     client = WargClient(
         registry=registry,
         warg_url=warg_url,
-        access_token=os.environ.get('WARG_TOKEN'))
+        warg_token=warg_token,
+    )
 
     res = client.get_checkpoint(namespace=namespace)
 
@@ -44,11 +45,12 @@ def warg_pull(registry, warg_url, namespace, name, version=None):
     # get content sources
     res = client.get_content_sources(
         namespace=namespace,
-        digest=digest
+        digest=digest,
     )
 
     if not res.content_sources:
         raise error('failed to fetch sources')
+
     digest, sources = res.content_sources.popitem()
     if not sources:
         raise error('failed to fetch sources')

wasm_action-0.0.2.dist-info/METADATA

@@ -0,0 +1,117 @@
+Metadata-Version: 2.3
+Name: wasm-action
+Version: 0.0.2
+Summary: Interact with WebAssembly registries.
+Requires-Dist: click>=8.2.1
+Requires-Dist: cryptography>=45.0.6
+Requires-Dist: leb128>=1.0.8
+Requires-Dist: protobuf>=6.32.1
+Requires-Dist: pydantic<2
+Requires-Dist: python-dateutil>=2.8.2
+Requires-Dist: requests>=2.32.4
+Requires-Dist: semver>=3.0.4
+Requires-Dist: urllib3>=1.25.3
+Requires-Dist: validators>=0.35.0
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# wasm-action
+
+**Interact with WebAssembly registries.**
+
+## Features
+* Versatile use as a GitHub [action](https://github.com/marketplace/actions/wasm-action), CLI or Python [library](https://pypi.org/project/wasm-action/).
+* Supported registry types: warg (wa.dev)
+* Supported artifact types: wasm
+* Supported actions: pull (public and private packages)
+* Supports Python 3.10+ on Linux, MacOS and Windows
+
+## Usage
+### Pull from registry
+```
+      - uses: xelato/wasm-action
+        with:
+          action: pull
+          registry: wa.dev
+          package: component-book:adder
+```
+
+To pull a private package define your [token](https://wa.dev/account/credentials/new):
+```
+        env:
+          WARG_TOKEN: ${{ secrets.WARG_TOKEN }}
+```
+
+#### Inputs
+
+| Name | Description | Required | Example |
+|------|-------------|----------|---------|
+|action|Pull from registry|yes|pull|
+|registry|Registry domain name|yes|wa.dev|
+|package|Package specification|yes|namespace:name@version<br>namespace:name<br>namespace/name<br>namespace/name@version|
+|path|Target path to save the download|no|file.wasm|
+
+#### Outputs:
+| Name | Description | Example |
+|------|-------------|---------|
+|registry|Registry domain name|wa.dev|
+|registry-type|Detected registry type|warg|
+|package|Package|foo:bar@1.2.3|
+|package-namespace|Package namespace|foo|
+|package-name|Package name|bar|
+|package-version|Package version|1.2.3|
+|filename|Download location|foo-bar_1.2.3.wasm|
+|digest|File hash|sha256:2afffac0...|
+
+## CLI
+The tool can be run without installing using [uv](https://docs.astral.sh/uv/).
+```
+$ uvx wasm-action --help
+Usage: wasm-action [OPTIONS] COMMAND [ARGS]...
+
+Options:
+  --help  Show this message and exit.
+
+Commands:
+  pull  Pull from a WebAssembly registry
+  push  Push to a WebAssembly registry
+```
+```
+$ uvx wasm-action pull --help
+Usage: wasm-action pull [OPTIONS]
+
+  Pull from a WebAssembly registry
+
+Options:
+  --registry TEXT    registry domain name  [required]
+  --package TEXT     package spec  [required]
+  --path TEXT        filename
+  --warg-token TEXT  warg token
+  --help             Show this message and exit.
+```
+```
+$ uvx wasm-action pull --registry wa.dev --package wasi:io
+registry=wa.dev
+registry-type=warg
+warg-url=https://warg.wa.dev
+package=wasi:io@0.2.0
+package-namespace=wasi
+package-name=io
+package-version=0.2.0
+digest=sha256:c33b1dbf050f64229ff4decbf9a3d3420e0643a86f5f0cea29f81054820020a6
+filename=wasi:io@0.2.0.wasm
+```
+```
+$ file wasi:io@0.2.0.wasm 
+wasi:io@0.2.0.wasm: WebAssembly (wasm) binary module version 0x1000d
+```
+
+## Use as Library
+The package is [published](http://pypi.org/project/wasm-action/) to the Python Package Index and can be installed/depended-on under the name `wasm-action` on all [supported](https://devguide.python.org/versions/#versions) Python versions.
+```
+$ pip install wasm-action
+```
+```
+> import wasm_action as wa
+```
+However, the library interface is not yet standardised and may (and will!) change.

{wasm_action-0.0.1.dist-info → wasm_action-0.0.2.dist-info}/RECORD

@@ -1,11 +1,11 @@
 wasm_action/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-wasm_action/action.py,sha256=CR6QM4YSIU-OvPWhdBt8EgpgDM-fmoIcfD1xdn29o44,3747
+wasm_action/action.py,sha256=60vyJNeNqmK5BSlgRUXpYGH4EPFPQqIaBQG5sWty4Ew,3610
 wasm_action/model.py,sha256=lwoJbAzsjxOAxIj8sdG74fzkWlrb6LXN8IGuzqryCAE,410
-wasm_action/util.py,sha256=MHdcDqZeaQeVs4zOJAiP6GDDMhFScktdqNM_LRsb6wM,2124
-wasm_action/warg_client.py,sha256=MezZQ-RaraH_t7tmlWMZrJ-njmJ6U5ZxOt0ae_YpmOo,2453
-wasm_action/warg_crypto.py,sha256=uIu-j3je3g7q1hbmXPqC1SX-ktLPfEFu0sM5qJaolH0,4064
+wasm_action/util.py,sha256=-uf6mnrW7xcxzk_bRUBZ1pVsdtOBmoRiDsLodA2_nf8,3256
+wasm_action/warg_client.py,sha256=h8CLMgV8gcXN7uRjaq9YWgXJdblA3IF8yuZVef1Fo5E,2584
+wasm_action/warg_crypto.py,sha256=DtgM_Mv3HPtNyiQFPTsC2SWUHf2mukmEdTn2FievijA,4098
 wasm_action/warg_proto.py,sha256=ui6rPfC_5IQQheOAwCxOL--r_tmvN-hc50NlLC5bgn4,6226
-wasm_action/warg_pull.py,sha256=W9Peix6BTaDQ0hFb-9jDTqIuSmp0PkQPEPG1oXiOYto,2634
+wasm_action/warg_pull.py,sha256=fGpWl_M9qkJwnU8gj8xibejwCwdVnoZczmsQg_RlNLc,2658
 warg_openapi/__init__.py,sha256=SYu5PkULIS11I_ZqQ_Iyn2inDdkCKJ_hDFwO5RR3mLE,7391
 warg_openapi/api/__init__.py,sha256=CYGG-oyV5Mli6yDOhB-vbKvqbwvQQK3fLbC6tCU3i6Y,350
 warg_openapi/api/content_api.py,sha256=1UZ2jiAIxE8fXncQ2cEC1l9yYb4-EU1kf7CN7I54iu0,8229
@@ -65,7 +65,7 @@ warg_openapi/models/sourcing_record.py,sha256=etggYo08PM4j7WJlhdWu8tG036johQwyYL
 warg_openapi/models/timestamped_checkpoint.py,sha256=HvpqFUAzxb4AlhFOd1FHi8gKYAvMD4W_mUltVBUNDfQ,3530
 warg_openapi/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 warg_openapi/rest.py,sha256=esTaIvd-RN8XURlnK_ALzgEyd5n1853hJRoAdCe7C3k,14044
-wasm_action-0.0.1.dist-info/WHEEL,sha256=M6du7VZflc4UPsGphmOXHANdgk8zessdJG0DBUuoA-U,78
-wasm_action-0.0.1.dist-info/entry_points.txt,sha256=Pnmatc0eyT_X-K4qiGs-KZslG8HAkbzbRwon0tXjUng,57
-wasm_action-0.0.1.dist-info/METADATA,sha256=_DzlQb01u4vUJrBOzA7M7gUr3P3Uv_AlioGnlIpxTTo,1473
-wasm_action-0.0.1.dist-info/RECORD,,
+wasm_action-0.0.2.dist-info/WHEEL,sha256=ZHijuPszqKbNczrBXkSuoxdxocbxgFghqnequ9ZQlVk,79
+wasm_action-0.0.2.dist-info/entry_points.txt,sha256=Pnmatc0eyT_X-K4qiGs-KZslG8HAkbzbRwon0tXjUng,57
+wasm_action-0.0.2.dist-info/METADATA,sha256=sJ7bXb34ugQDV0MXxSG9_sRg3uUXllXiB0JoItoyEro,3446
+wasm_action-0.0.2.dist-info/RECORD,,

{wasm_action-0.0.1.dist-info → wasm_action-0.0.2.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: uv 0.9.5
+Generator: uv 0.9.10
 Root-Is-Purelib: true
 Tag: py3-none-any

wasm_action-0.0.1.dist-info/METADATA

@@ -1,53 +0,0 @@
-Metadata-Version: 2.3
-Name: wasm-action
-Version: 0.0.1
-Summary: Interact with WebAssembly registries.
-Requires-Dist: click>=8.2.1
-Requires-Dist: cryptography>=45.0.6
-Requires-Dist: leb128>=1.0.8
-Requires-Dist: protobuf>=6.32.1
-Requires-Dist: pydantic<2
-Requires-Dist: python-dateutil>=2.8.2
-Requires-Dist: requests>=2.32.4
-Requires-Dist: semver>=3.0.4
-Requires-Dist: urllib3>=1.25.3
-Requires-Dist: validators>=0.35.0
-Requires-Python: >=3.12
-Description-Content-Type: text/markdown
-
-# wasm-action
-
-**Interact with WebAssembly registries.**
-
-## Features
-* Versatile use as a GitHub action, CLI or Python library.
-* Supported registry types: warg (wa.dev)
-* Supported artifact types: wasm
-* Supported actions: pull
-
-## Usage
-### Pull from registry
-```
-      - name: Pull from registry
-        uses: xelato/wasm-action
-        id: pull
-        with:
-          action: pull
-          registry: wa.dev
-          namespace: component-book
-          name: adder
-```
-
-Outputs:
-```
-      - name: Display outputs
-        shell: bash
-        run: |
-          echo "registry:" ${{ steps.pull.outputs.registry }}
-          echo "registry-type:" ${{ steps.pull.outputs.registry-type }}
-          echo "namespace:" ${{ steps.pull.outputs.namespace }}
-          echo "name:" ${{ steps.pull.outputs.name }}
-          echo "version:" ${{ steps.pull.outputs.version }}
-          echo "filename:" ${{ steps.pull.outputs.filename }}
-          echo "digest:" ${{ steps.pull.outputs.digest }}
-```