Skip to main content

Async Comlink

Async Comlink is an asynchronous Python wrapper for the swgoh-comlink service. It provides a convenient way for making API requests and includes built-in support for HMAC authentication, enabling secure communication with the service.

Features

  • Fully asynchronous, non-blocking API requests via aiohttp
  • Compact JSON serialization for compatibility with the API
  • Parameter validation to prevent invalid requests
  • Debug mode to log requests and help with troubleshooting
  • Support for HMAC authentication to ensure secure communication

Installation

Async Comlink is available on PyPi:

pip install async-comlink

Dependencies: aiohttp

Usage

Basic example of using Async Comlink to make an API request:

import asyncio
from async_comlink import AsyncComlink

async def main():
    # Basic use (for long-lived usage)
    comlink = AsyncComlink()
    response = await comlink.get_player(allycode=123456789)

    # Context manager use (for short-lived usage)
    async with AsyncComlink() as comlink:
        response = await comlink.get_player(allycode=123456789)

asyncio.run(main())

For more information regarding endpoints and their parameters, refer to the swgoh-comlink documentation.

Initialization Parameters

Parameter Description Default
url The base URL of the swgoh-comlink service. http://localhost:3000
host The host of the swgoh-comlink service. None
port The port of the swgoh-comlink service. 3000
access_key The access key to use for HMAC authentication. None
secret_key The secret key to use for HMAC authentication. None
debug If debug mode should be enabled to log requests and suppress raised exceptions on errors. False

License

Async Comlink is released under the MIT License.

Metadata

Release files for async-comlink 1.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for async-comlink 1.1.0
File Size Uploaded Provenance
async_comlink-1.1.0.tar.gz 8.3 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for async-comlink 1.1.0
File Interpreter ABI Platform
async_comlink-1.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 16.5 kB

Security for async-comlink 1.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page