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)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| async_comlink-1.1.0.tar.gz | 8.3 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| async_comlink-1.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 16.5 kB
Release files / async_comlink-1.1.0.tar.gz
| Download URL | async_comlink-1.1.0.tar.gz |
|---|---|
| Size | 8.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
30f5756444ebb8103521484e238fb04d5eb3cb35fdd1cd774091075b21259036
|
|
BLAKE2b-256 checksum How to use checksums |
c65b21135c338562aad9705b23b59679f3bafdb207207d78f9fa7c986af6d483
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.0.1 CPython/3.10.11
|
Release files / async_comlink-1.1.0-py3-none-any.whl
| Download URL | async_comlink-1.1.0-py3-none-any.whl |
|---|---|
| Size | 8.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
df7b632d9899bcc2895fe4a59bfa9e764a390c69860a85216e4cfe79a2ab1009
|
|
BLAKE2b-256 checksum How to use checksums |
41e023c910b3a64cebb54fabd02ef5bb75bd27efb1cd6a6d18de5249dbd74141
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.0.1 CPython/3.10.11
|
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.