Skip to main content

Public runtime and manifest contract for Kangal plugins

Project description

Kangal Plugin SDK

The Kangal Plugin SDK provides the public Python runtime and signed manifest contract for custom Kangal gateway policies.

Install

python -m pip install kangal-plugin-sdk

Python 3.11 or newer is required.

Create a plugin

from typing import Any

from kangal_plugin_sdk import Plugin


class AddRequestHeader(Plugin):
    async def before_request(
        self,
        request: Any,
        headers: dict[str, str],
        tenant_id: str,
    ) -> dict[str, str]:
        return {**headers, "X-Kangal-Plugin": "active"}

The package also exposes helpers for canonical manifest hashing, protocol validation, and Ed25519 manifest signing. Start from the complete plugin SDK guide and the header policy example.

Verify a release

Every GitHub release includes a wheel, source distribution, and SHA256SUMS.txt. Each package artifact also receives a keyless Sigstore bundle that binds its digest to the GitHub Actions release identity.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kangal_plugin_sdk-1.0.2.tar.gz (3.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kangal_plugin_sdk-1.0.2-py3-none-any.whl (4.3 kB view details)

Uploaded Python 3

File details

Details for the file kangal_plugin_sdk-1.0.2.tar.gz.

File metadata

  • Download URL: kangal_plugin_sdk-1.0.2.tar.gz
  • Upload date:
  • Size: 3.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for kangal_plugin_sdk-1.0.2.tar.gz
Algorithm Hash digest
SHA256 8d111a7d2769a8d806bf8885ddaf25df291686f9fc16bbdbd7ec5666128b4fba
MD5 8e6ab7341b7bb5aff48a050820dcc10d
BLAKE2b-256 3432c6655b745b1d98497095debbe2b927cf3bc917b0173f2f98b85e70300382

See more details on using hashes here.

Provenance

The following attestation bundles were made for kangal_plugin_sdk-1.0.2.tar.gz:

Publisher: publish-plugin-sdk.yml on latifv/kangal

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file kangal_plugin_sdk-1.0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for kangal_plugin_sdk-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 c840f9f048226003f8b871ebc9698e3ca0c8d07eea46f79a7d7d08631841d670
MD5 9ac841876af6b0119199690418b04d3b
BLAKE2b-256 01377610ddb5ca74a4e3699a8ba7fff496e1dc60e4bb918bee1bf1f93b77acf1

See more details on using hashes here.

Provenance

The following attestation bundles were made for kangal_plugin_sdk-1.0.2-py3-none-any.whl:

Publisher: publish-plugin-sdk.yml on latifv/kangal

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page