swgoh-comlink 1.12.1

Python 3 interface library for swgoh-comlink (https://github.com/swgoh-utils/swgoh-comlink)

comlink-python

Description

A python wrapper for the swgoh-comlink tool.

Installation

Install from PyPi package repository using the following shell command.

pip install swgoh_comlink

Usage

Basic default usage example:

from swgoh_comlink import SwgohComlink

comlink = SwgohComlink()
player_data = comlink.get_player(245866537)
player_name = player_data['name']
guild_id = player_data['guildId']
guild = comlink.get_guild(guild_id)
guild_name = guild['profile']['name']

Usage example with non-default settings for a swgoh-comlink service running on the local machine at TCP port 3500:

from swgoh_comlink import SwgohComlink

comlink = SwgohComlink(url='http://localhost:3500')
player_data = comlink.get_player(245866537)
player_name = player_data['name']
guild_id = player_data['guildId']
guild = comlink.get_guild(guild_id)
guild_name = guild['profile']['name']

Usage example with non-default settings for a swgoh-comlink service running on the local machine at TCP port 3500 and swgoh-stats service running on the local machine at TCP port 3550:

from swgoh_comlink import SwgohComlink

comlink = SwgohComlink(url='http://localhost:3500', stats_url='http://localhost:3550')
player_data = comlink.get_player(245866537)
player_roster = player_data['rosterUnit']
roster_with_stats = comlink.get_unit_stats(player_roster)

Usage example with MHAC enabled:

from swgoh_comlink import SwgohComlink

comlink = SwgohComlink(
    url='http://localhost:3000', 
    access_key='public_key', 
    secret_key='this_string_should_be_secret'
)
player_data = comlink.get_player(allycode=245866537)
player_name = player_data['name']

Parameters

• url: the URL where the swgoh-comlink service is running. Defaults to http://localhost:3000
• access_key: The "public" portion of the shared key used in HMAC request signing. Defaults to None which disables HMAC signing of requests. Can also be read from the ACCESS_KEY environment variable.
• secret_key: The "private" portion of the key used in HMAC request signing. Defaults to None which disables HMAC signing of requests. Can also be read from the SECRET_KEY environment variable.

See the online wiki for more information.

Support

Issues can be reported in GitHub.

Join the discord server