【Python】Steam Web API Keyを発行して、そこから最近遊んだゲームを可視化する

はじまり#

リサちゃん

さて、今までどんなゲームを遊んだかなあ。

ペンギン

Pythonでデータを可視化でございますか。

PythonからSteamの情報を覗く。#

なんか最近、Pythonを再び触り始めたので、今回は少し趣向を変えてやっていこうと思います。

そこで今回は、自分のSteamアカウントに紐付いている情報を引っ張ってきて、そのデータを何らかのグラフというかチャートの形でプロットしていきたいと思います。

steamcommunity.com

Steam コミュニティ :: Steam Web API ドキュメント

steamcommunity.com

まあでも最近あんまりゲームしていないんで見栄えの良いグラフになるかが不安です・・・。それじゃあ行ってみましょう。

今回使うパッケージ#

Pythonのバージョンは、3.12です。

今回は、Steam Web APIを直接叩くのではなく、PyPIにあるpython-steam-apiパッケージを使って、Steamの情報を抜き出していきたいと思います。このパッケージは、「Steam Web API」という公式APIを叩くためのラッパーのようなものです。

このパッケージ、リファレンスは見つけられなかったのですが、パッケージの使用例の部分が沢山書いてあるので、リファレンスを見る必要はないかなと思いました。気になったところはレスポンスをもう少し深く見れば良いし。豊富なドキュメントで助かります。

pypi.org

Client Challenge

pypi.org

可視化するためのパッケージとしては、matplotlibの結果をFastAPIとPanelで表示する感じで行きます。

panel.holoviz.org

Overview — Panel v1.9.1

panel.holoviz.org

Steam Web API Keyを生成する。#

Steam Web APIを叩くために、API Keyを生成します。

まずは、Steamアプリを自分のスマホにインストールしてログインして、「Steamガードモバイル認証」をオンにする必要があります。ここの手順は省略します。

そしたら、このページからSteam Web API Keyを生成できます。

そのページで、ドメイン名を入力して、「Steam Web API利用規約に同意します」にチェックを入れて、「登録」します。

すると、「確認が必要です（Confirmation Required）」という文言が表示されるます。

そしたら次に、自分のスマホのSteamアプリを開きます。そしたら、画面下部のメニューバーから一番右の「縦並びの3本の横線」ボタンをタップして、Confirmationsをタップします。

Confirmationsをタップすると、先程のSteam Web API Keyを生成するためのページからのリクエストが届いているので、これをConfirmします。

そして、PCのページの方を確認すると、Steam Web API Keyが生成されました。生成したキーはこのページで確認することができます。

Steamの情報を取得する。#

ユーザーの情報を取得する。#

それでは、先程生成したSteam Web API Keyでpython-steam-apiパッケージを使っていきます。ちなみに、Steam Web APIから情報を取得する対象のSteamアカウントは、外部へと公開している設定になっている必要があります。

こっちのパッケージの方が、Steam Web APIから直接叩くよりもレスポンスの内容が整理されていて助かります。

まずは、python-steam-apiパッケージをインストールします。

1
pip install python-steam-api

そしたら最初に、ユーザーの基本情報を取得していきます。

1
import os
2
from pprint import pprint
3

4
from steam_web_api import Steam
5

6
STEAM_API_KEY = os.environ.get("STEAM_API_KEY")
7
steam = Steam(STEAM_API_KEY)
8

9
user = steam.users.search_user("the12thchairman")
10
pprint(user)

レスポンスが取得できました。アバター画像やら最後にログオフした日時などが取れました。クランの概念を今まで知らなかった・・・。

1
{'player': {'avatar': 'https://avatars.steamstatic.com/427ef7d5f8ad7b21678f69bc8afc95786cf38fe6.jpg',
2
  'avatarfull': 'https://avatars.steamstatic.com/427ef7d5f8ad7b21678f69bc8afc95786cf38fe6_full.jpg',
3
  'avatarhash': '427ef7d5f8ad7b21678f69bc8afc95786cf38fe6',
4
  'avatarmedium': 'https://avatars.steamstatic.com/427ef7d5f8ad7b21678f69bc8afc95786cf38fe6_medium.jpg',
5
  'communityvisibilitystate': 3,
6
  'loccountrycode': 'US',
7
  'personaname': 'The12thChairman',
8
  'personastate': 0,
9
  'personastateflags': 0,
10
  'primaryclanid': '103582791429521408',
11
  'profilestate': 1,
12
  'profileurl': 'https://steamcommunity.com/id/the12thchairman/',
13
  'steamid': '76561198995017863',
14
  'timecreated': 1570311509}
15
}

次に、steamidからユーザー情報を紐づけていきます。

1
import os
2
from pprint import pprint
3

4
from steam_web_api import Steam
5

6
STEAM_API_KEY = os.environ.get("STEAM_API_KEY")
7
steam = Steam(STEAM_API_KEY)
8

9
STEAM_ID = os.environ.get("MY_STEAM_ID")
10
user = steam.users.get_user_details(STEAM_ID)
11
pprint(user)

同様に、ユーザー情報に関するレスポンスが取得できました。

1
{'player': {'avatar': 'https://avatars.steamstatic.com/d7fee5bba9e4a5aaacff74551c145d58289041df.jpg',
2
    'avatarfull': 'https://avatars.steamstatic.com/d7fee5bba9e4a5aaacff74551c145d58289041df_full.jpg',
3
    'avatarhash': 'd7fee5bba9e4a5aaacff74551c145d58289041df',
4
    'avatarmedium': 'https://avatars.steamstatic.com/d7fee5bba9e4a5aaacff74551c145d58289041df_medium.jpg',
5
    'communityvisibilitystate': 3,
6
    'lastlogoff': 1733937104,
7
    'loccountrycode': 'JP',
8
    'locstatecode': '40',
9
    'personaname': 'kinkinbeer135ml',
10
    'personastate': 1,
11
    'personastateflags': 0,
12
    'primaryclanid': '103582791429521408',
13
    'profilestate': 1,
14
    'profileurl': 'https://steamcommunity.com/id/kinkingame24bit/',
15
    'steamid': 'XXXXXXXXXXXXXXXXXX',
16
    'timecreated': 1540612096}}

そのSteamアカウントのフレンド一覧を取得することも可能です。フィールドの数が煩雑になってきたのでpydanticで型安全を担保します。（レスポンスの内容は省略します。）

src/config.py:

1
import os
2

3
def get_env_variable(key: str) -> str:
4
    # return os.environ[key]
5
    return os.getenv(key)
6

7
def get_steam_api_key():
8
    return get_env_variable("STEAM_API_KEY")
9

10
def get_my_steam_id():
11
    return get_env_variable("MY_STEAM_ID")

src/steam.py:

1
import os
2
from pprint import pprint
3
from typing import List, Optional
4
from pydantic import BaseModel, HttpUrl
5
import inspect
6

7
from steam_web_api import Steam
8
# Local packages
9
import config as cfg
10

11
class SteamPlayerProfile(BaseModel):
12
    avatar: HttpUrl
13
    avatarfull: HttpUrl
14
    avatarhash: str
15
    avatarmedium: HttpUrl
16
    communityvisibilitystate: int
17
    personaname: str
18
    personastate: int
19
    personastateflags: int
20
    primaryclanid: str
21
    profilestate: int
22
    profileurl: HttpUrl
23
    steamid: str
24
    timecreated: int
25

26
class SteamFriendProfile(SteamPlayerProfile):
27
    friend_since: int
28
    relationship: str
29

30
def get_steam_client() -> Steam:
31
    return Steam(cfg.get_steam_api_key())
32

33
def retrieve_user(steam: Steam, steam_id: str) -> SteamPlayerProfile:
34
    pprint(f"{func_name}: start retrieving steam player info")
35
    user = steam.users.get_user_details(steam_id)
36
    steam_profile = SteamPlayerProfile(**user["player"])
37

38
    func_name = inspect.currentframe().f_code.co_name
39
    pprint(f"{func_name}: finish retrieving steam player info")
40
    pprint(steam_profile)
41
    return steam_profile
42

43
def retrieve_friends(steam: Steam, steam_id: str)-> List[SteamPlayerProfile]:
44
    pprint(f"{func_name}: start retrieving steam friends info")
45
    user = steam.users.get_user_friends_list(steam_id)
46
    def to_profile_class(profile: dict) -> SteamFriendProfile:
47
        return SteamFriendProfile(**profile)
48
    steam_profiles = list(map(to_profile_class, user["friends"]))
49

50
    func_name = inspect.currentframe().f_code.co_name
51
    pprint(f"{func_name}: finish retrieving steam friends info")
52
    pprint(steam_profiles)
53
    return steam_profiles
54

55
if __name__ == "__main__":
56
    steam = get_steam_client()
57
    STEAM_ID = cfg.get_my_steam_id()
58
    user = retrieve_user(steam, STEAM_ID)
59
    friends = retrieve_friends(steam, STEAM_ID)

ゲームの情報を取得する。#

そしたら次に、ユーザーが所持しているゲームの一覧を取得してみます。加えて、先程のようにPydanticベースのクラスで型検証して、デコレータで関数の実行部分の可視化もします。

1
from pprint import pprint
2
from typing import List, Optional
3
from pydantic import BaseModel, HttpUrl
4
from functools import wraps
5

6
def function_decorator(func):
7
    @wraps(func)
8
    def wrapTheFunction(*args, **kwargs):
9
        pprint(f"{func.__name__}(): start executing...")
10
        result = func(*args, **kwargs)
11
        # print(f"I am doing some bullshit before executing func.__name__()")
12
        pprint(f"{func.__name__}(): finish executing.")
13

14
        return result
15

16
    return wrapTheFunction
17

18
class SteamGameProfile(BaseModel):
19
    appid: int
20
    img_icon_url: str
21
    name: str
22
    playtime_2weeks: Optional[int] = None
23
    playtime_deck_forever: int
24
    playtime_disconnected: int
25
    playtime_forever: int
26
    playtime_linux_forever: int
27
    playtime_mac_forever: int
28
    playtime_windows_forever: int
29
    rtime_last_played: int
30

31
@function_decorator
32
def retrieve_owned_games(steam: Steam, steam_id: str):
33
    res = steam.users.get_owned_games(steam_id)
34
    def to_profile_class(profile: dict) -> SteamGameProfile:
35
        return SteamGameProfile(**profile)
36
    steam_games = list(map(to_profile_class, res["games"]))
37
    pprint(steam_games)
38
    pprint(res["game_count"])
39
    pprint(len(steam_games))
40
    return steam_games
41

42
if __name__ == "__main__":
43
    steam = get_steam_client()
44
    STEAM_ID = cfg.get_my_steam_id()
45
    games = retrieve_owned_games(steam, STEAM_ID)

実行すると色々とゲームに関する情報を取得できました。2週間以内に起動されたゲームだけには、"playtime_2weeks"というフィールドがありました。PydanticではそのフィールドだけオプショナルでNoneに設定しています。

1
'retrieve_owned_games(): start executing...'
2
[SteamGameProfile(appid=400, img_icon_url='cfa928ab4119dd137e50d728e8fe703e4e970aff', name='Portal', playtime_2weeks=None, playtime_deck_forever=0, playtime_disconnected=0, playtime_forever=205, playtime_linux_forever=0, playtime_mac_forever=0, playtime_windows_forever=205, rtime_last_played=1691772949),
3
 SteamGameProfile(appid=40100, img_icon_url='96e22cb9c9b063c9f0398f248fef850a679ced5a', name='Supreme Commander 2', playtime_2weeks=None, playtime_deck_forever=0, playtime_disconnected=0, playtime_forever=0, playtime_linux_forever=0, playtime_mac_forever=0, playtime_windows_forever=0, rtime_last_played=0),
4
 SteamGameProfile(appid=620, img_icon_url='2e478fc6874d06ae5baf0d147f6f21203291aa02', name='Portal 2', playtime_2weeks=None, playtime_deck_forever=0, playtime_disconnected=0, playtime_forever=2, playtime_linux_forever=0, playtime_mac_forever=0, playtime_windows_forever=2, rtime_last_played=1696106875),
5

6
...
7

8
 SteamGameProfile(appid=1601580, img_icon_url='5e66161686d4e2503a8a42aab9e8bc1c46c68fc1', name='Frostpunk 2', playtime_2weeks=None, playtime_deck_forever=0, playtime_disconnected=0, playtime_forever=1569, playtime_linux_forever=0, playtime_mac_forever=0, playtime_windows_forever=1569, rtime_last_played=1727178622),
9
 SteamGameProfile(appid=983870, img_icon_url='8fe2f591098d69505dab3154c7397ca2f7594bc2', name='FOUNDRY', playtime_2weeks=None, playtime_deck_forever=0, playtime_disconnected=0, playtime_forever=0, playtime_linux_forever=0, playtime_mac_forever=0, playtime_windows_forever=0, rtime_last_played=0),
10
 SteamGameProfile(appid=2854710, img_icon_url='4f408e9f135d7d2d117af3697c7f1a4bfaf10771', name='Chocolate Factory', playtime_2weeks=4, playtime_deck_forever=0, playtime_disconnected=0, playtime_forever=2017, playtime_linux_forever=0, playtime_mac_forever=0, playtime_windows_forever=2017, rtime_last_played=1733042847)]
11
185
12
185
13
'retrieve_owned_games(): finish executing.'

それではそのゲームで自分が積み重ねたstatsやachievementsを確認してみます。

1
class Achievement(BaseModel):
2
    achieved: int
3
    name: str
4

5
class Stat(BaseModel):
6
    name: str
7
    value: int
8

9
class SteamGameData(BaseModel):
10
    achievements: Optional[List[Achievement]] = None
11
    gameName: str
12
    stats: Optional[List[Stat]] = None
13
    steamID: str
14

15
@function_decorator
16
def retrieve_game_data(steam: Steam, steam_id: str, app_id: int):
17
    game_data = None
18
    try:
19
        res = steam.apps.get_user_stats(steam_id, app_id)
20
        game_data = SteamGameData(**res["playerstats"])
21
    except Exception as e:
22
        pprint(e.args[0])
23
        if "400 Bad Request" not in e.args[0]:
24
            raise e.args[0] # Raise content of exception.
25
        pass
26
    pprint(game_data)
27
    return game_data
28

29
if __name__ == "__main__":
30
    steam = get_steam_client()
31
    STEAM_ID = cfg.get_my_steam_id()
32

33
    game_data = retrieve_game_data(steam, STEAM_ID, 1888160)
34
    print("\n")
35
    game_data = retrieve_game_data(steam, STEAM_ID, 1259790)
36
    print("\n")
37
    game_data = retrieve_game_data(steam, STEAM_ID, 2854710)

statsフィールドだけ無いゲームや、statsフィールドとachievementsフィールドの両方とも無いのでリクエストすると例外が発生するゲームもあります。なので、レスポンスで400 Bad Requestが返ってくる場合にはNoneとすることにしました。

個人的に、テトリスのstatsは見てみたかったですね。

1
'retrieve_game_data(): start executing…'
2
SteamGameData(achievements=[Achievement(achieved=1, name='ACH02'), Achievement(achieved=1, name='ACH03'), Achievement(achieved=1, name='ACH04'), Achievement(achieved=1, name='ACH05'), Achievement(achieved=1, name='ACH06'), Achievement(achieved=1, name='ACH07'), Achievement(achieved=1, name='ACH08'), Achievement(achieved=1, name='ACH09'), Achievement(achieved=1, name='ACH10'), Achievement(achieved=1, name='ACH11'), Achievement(achieved=1, name='ACH12'), Achievement(achieved=1, name='ACH13'), Achievement(achieved=1, name='ACH14'), Achievement(achieved=1, name='ACH15'), Achievement(achieved=1, name='ACH16'), Achievement(achieved=1, name='ACH17'), Achievement(achieved=1, name='ACH18'), Achievement(achieved=1, name='ACH19'), Achievement(achieved=1, name='ACH20'), Achievement(achieved=1, name='ACH21'), Achievement(achieved=1, name='ACH22'), Achievement(achieved=1, name='ACH23'), Achievement(achieved=1, name='ACH24'), Achievement(achieved=1, name='ACH25'), Achievement(achieved=1, name='ACH26'), Achievement(achieved=1, name='ACH27'), Achievement(achieved=1, name='ACH28'), Achievement(achieved=1, name='ACH29')], gameName='ARMORED CORE VI FIRES OF RUBICON', stats=None, steamID='XXXXXXXXXXXXX')
3
'retrieve_game_data(): finish executing.'
4
'retrieve_game_data(): start executing…'
5
SteamGameData(achievements=[Achievement(achieved=1, name='ID_02_WonKnockoutPast03'), Achievement(achieved=1, name='ID_03_WonKnockoutPast05'), Achievement(achieved=1, name='ID_04_WonKnockoutPast10'), Achievement(achieved=1, name='ID_29_TetoMinoErase1000'), Achievement(achieved=1, name='ID_30_TetoMinoErase10000'), Achievement(achieved=1, name='ID_31_TetoTETRISx50'), Achievement(achieved=1, name='ID_32_TetoTETRISx100'), Achievement(achieved=1, name='ID_33_TetoB2Bx25'), Achievement(achieved=1, name='ID_34_TetoB2Bx50'), Achievement(achieved=1, name='ID_35_Teto5REN'), Achievement(achieved=1, name='ID_36_Teto8REN'), Achievement(achieved=1, name='ID_37_TetoPERFECT1'), Achievement(achieved=1, name='ID_38_TetoPERFECT3'), Achievement(achieved=1, name='ID_39_TetoMinoErase50000'), Achievement(achieved=1, name='ID_40_TetoTETRISx200'), Achievement(achieved=1, name='ID_41_TetoB2Bx100'), Achievement(achieved=1, name='ID_42_TetoMinoErase100000')], gameName='Tenpex', stats=[Stat(name='stat_knockoutPastMaxCount', value=14), Stat(name='stat_adventureAchivement', value=1), Stat(name='stat_puyoEraseCount', value=327), Stat(name='stat_puyoChain3Count', value=3), Stat(name='stat_puyoChain4Count', value=2), Stat(name='stat_puyoChain5Count', value=1), Stat(name='stat_puyoAllEraseCount', value=1), Stat(name='stat_tetoMinoEraseCount', value=855830), Stat(name='stat_tetoTetrisCount', value=3533), Stat(name='stat_tetoB2BCount', value=2832), Stat(name='stat_tetoRENMaxValue', value=8), Stat(name='stat_tetoPerfectCount', value=216), Stat(name='stat_sVS', value=1728), Stat(name='stat_sSWAP', value=6), Stat(name='stat_sMIX', value=4), Stat(name='stat_sMARATHON', value=1542)], steamID='XXXXXXXXXXX')
6
'retrieve_game_data(): finish executing.'
7
'retrieve_game_data(): start executing…'
8
'400 Bad Request {}'
9
None
10
'retrieve_game_data(): finish executing.'

steam.apps.get_user_achievements("<steam_id>", "<app_id>")と検索することで、achievementsのみを取得することも可能みたいです。

1
class Achievement(BaseModel):
2
    achieved: int
3
    apiname: str
4
    description: str
5
    name: str
6
    unlocktime: int
7

8
class SteamGameAchievements(BaseModel):
9
    achievements: List[Achievement]
10
    gameName: str
11
    steamID: str
12
    success: bool
13

14
@function_decorator
15
def retrieve_achievements(steam: Steam, steam_id: str, app_id: int):
16
    achievements = None
17
    try:
18
        res = steam.apps.get_user_achievements(steam_id, app_id)
19
        achievements = SteamGameAchievements(**res["playerstats"])
20
    except Exception as e:
21
        pprint(e.args[0])
22
        if "400 Bad Request" not in e.args[0]:
23
            raise e.args[0] # Raise content of exception.
24
        pass
25
    pprint(achievements)
26
    return achievements
27

28
if __name__ == "__main__":
29
    steam = get_steam_client()
30
    STEAM_ID = cfg.get_my_steam_id()
31

32
    achievements = retrieve_achievements(steam, STEAM_ID, 1888160)
33
    achievements = retrieve_achievements(steam, STEAM_ID, 1259790)
34
    achievements = retrieve_achievements(steam, STEAM_ID, 2854710)

steam.apps.get_user_achievements("<steam_id>", "<app_id>")と検索する方が、achievementに関する情報がより詳細に格納されています。

1
'retrieve_achievements(): start executing…'
2
SteamGameAchievements(achievements=[Achievement(achieved=0, apiname='ACH00', description='Unlocked all achievements.', name='Armored Core', unlocktime=0), Achievement(achieved=0, apiname='ACH01', description='', name='The Perfect Mercenary', unlocktime=0), Achievement(achieved=1, apiname='ACH02', description='', name='Stargazer', unlocktime=1696261035), Achievement(achieved=1, apiname='ACH03', description='', name='Master of Arena', unlocktime=1695489096), Achievement(achieved=1, apiname='ACH04', description='', name='Asset Holder', unlocktime=1695996405), Achievement(achieved=1, apiname='ACH05', description='', name='Tuning Expert', unlocktime=1697118086), Achievement(achieved=1, apiname='ACH06', description='', name='The Fires of Raven', unlocktime=1694797344), Achievement(achieved=1, apiname='ACH07', description='', name='Liberator of Rubicon', unlocktime=1695064984), Achievement(achieved=1, apiname='ACH08', description='', name='Alea Iacta Est', unlocktime=1696261035), Achievement(achieved=1, apiname='ACH09', description='', name='Weapon Collector', unlocktime=1695996404), Achievement(achieved=1, apiname='ACH10', description='', name='External Parts Collector', unlocktime=1695996378), Achievement(achieved=1, apiname='ACH11', description='', name='Internal Parts Collector', unlocktime=1695996392), Achievement(achieved=1, apiname='ACH12', description='', name='Expansion Collector', unlocktime=1695104565), Achievement(achieved=1, apiname='ACH13', description='', name='Combat Log Collector', unlocktime=1695576602), Achievement(achieved=1, apiname='ACH14', description='', name='Data Log Collector', unlocktime=1693499027), Achievement(achieved=1, apiname='ACH15', description='', name='Testing Complete', unlocktime=1694468979), Achievement(achieved=1, apiname='ACH16', description='', name='Illegal Entry', unlocktime=1693148748), Achievement(achieved=1, apiname='ACH17', description='', name='Operation Wallclimber', unlocktime=1693497884), Achievement(achieved=1, apiname='ACH18', description='', name='Contact', unlocktime=1693516862), Achievement(achieved=1, apiname='ACH19', description='', name='Ocean Crossing', unlocktime=1693772650), Achievement(achieved=1, apiname='ACH20', description='', name='A New Threat', unlocktime=1694181014), Achievement(achieved=1, apiname='ACH21', description='', name='Ayre and the Coral', unlocktime=1694185005), Achievement(achieved=1, apiname='ACH22', description='', name='Into Unknown Territory', unlocktime=1694448640), Achievement(achieved=1, apiname='ACH23', description='', name='Re-education', unlocktime=1694620467), Achievement(achieved=1, apiname='ACH24', description='', name='The Floating City', unlocktime=1694623817), Achievement(achieved=1, apiname='ACH25', description='', name='MIA', unlocktime=1695570379), Achievement(achieved=1, apiname='ACH26', description='', name='Training Complete', unlocktime=1694113205), Achievement(achieved=1, apiname='ACH27', description='Assembled an AC.', name='Hardware Engineer', unlocktime=1693232881), Achievement(achieved=1, apiname='ACH28', description="Upgraded your AC's OS.", name='Software Engineer', unlocktime=1693499667), Achievement(achieved=1, apiname='ACH29', description='Changed the coloration of your AC.', name='Graphic Designer', unlocktime=1693149176)], gameName='ARMORED CORE™ VI FIRES OF RUBICON™', steamID='XXXXXXXXXXXXXXXXXXX', success=True)
3
'retrieve_achievements(): finish executing.'
4
'retrieve_achievements(): start executing…'
5
SteamGameAchievements(achievements=[Achievement(achieved=0, apiname='ID_01_AllRulePlayed', description='Played all 6 offline modes', name='Competitor', unlocktime=0), Achievement(achieved=1, apiname='ID_02_WonKnockoutPast03', description='Defeated 3 opponents in an Endurance match', name='Duelist (x3)', unlocktime=1691515720), Achievement(achieved=1, apiname='ID_03_WonKnockoutPast05', description='Defeated 5 opponents in an Endurance match', name='Duelist (x5)', unlocktime=1691515720), Achievement(achieved=1, apiname='ID_04_WonKnockoutPast10', description='Defeated 10 opponents in an Endurance match', name='Duelist (x10)', unlocktime=1691517402), Achievement(achieved=0, apiname='ID_05_AllTokoPuyoRulePlayed', description='Played all 3 Puyo Puyo Challenge modes', name='Competitor (Puyo Puyo)', unlocktime=0), Achievement(achieved=0, apiname='ID_06_AllTokoTetoRulePlayed', description='Played all 3 Tetris Challenge modes', name='Competitor (Tetris)', unlocktime=0), Achievement(achieved=0, apiname='ID_07_ClearAdventure', description='Completed the main story within Adventure mode and watched the ending', name='Historian', unlocktime=0), Achievement(achieved=0, apiname='ID_08_WonLeagueMatch01', description='Won your first Puzzle League match', name='Gladiator (x1)', unlocktime=0), Achievement(achieved=0, apiname='ID_09_WonClubMatch', description='Won your first Free Play match', name='Prize Fighter', unlocktime=0), Achievement(achieved=0, apiname='ID_10_AdventureAchievement50', description='Achieved 50% completion in Adventure mode', name='Wanderer', unlocktime=0), Achievement(achieved=0, apiname='ID_11_WonKnockoutPast15', description='Defeated 15 opponents in an Endurance match', name='Duelist (x15)', unlocktime=0), Achievement(achieved=0, apiname='ID_12_AdventureAchievement70', description='Achieved 70% completion in Adventure mode', name='Devotee', unlocktime=0), Achievement(achieved=0, apiname='ID_13_WonLeagueMatch10', description='Won ten Puzzle League matches', name='Gladiator (x10)', unlocktime=0), Achievement(achieved=0, apiname='ID_14_AdventureAchievement100', description='Achieved 100% completion in Adventure mode', name='Completionist', unlocktime=0), Achievement(achieved=0, apiname='ID_15_PuyoErase1000', description='Popped 1,000 Puyos in completed matches', name='Puyo King (x1,000)', unlocktime=0), Achievement(achieved=0, apiname='ID_16_PuyoErase10000', description='Popped 10,000 Puyos in completed matches', name='Puyo King (x10,000)', unlocktime=0), Achievement(achieved=0, apiname='ID_17_Puyo3Chain100', description='Performed a 3-Chain 100 times in completed matches', name='3-Chain Master', unlocktime=0), Achievement(achieved=0, apiname='ID_18_Puyo4Chain100', description='Performed a 4-Chain 100 times in completed matches', name='4-Chain Master', unlocktime=0), Achievement(achieved=0, apiname='ID_19_Puyo5Chain100', description='Performed a 5-Chain 100 times in completed matches', name='5-Chain Master', unlocktime=0), Achievement(achieved=0, apiname='ID_20_Puyo6Chain100', description='Performed a 6-Chain 100 times in completed matches', name='6-Chain Master', unlocktime=0), Achievement(achieved=0, apiname='ID_21_PuyoAllErase50', description='Performed an All Clear 50 times in completed matches.', name='Screen Cleaner (x50)', unlocktime=0), Achievement(achieved=0, apiname='ID_22_PuyoAllErase100', description='Performed an All Clear 100 times in completed matches', name='Screen Cleaner (x100)', unlocktime=0), Achievement(achieved=0, apiname='ID_23_Puyo3ColorErase', description='Cleared 3 different-colored Puyo groups simultaneously in a completed match', name='Chromatic Popper', unlocktime=0), Achievement(achieved=0, apiname='ID_24_Puyo4ColorErase', description='Cleared 4 different-colored Puyo groups simultaneously in a completed match', name='Prismatic Popper', unlocktime=0), Achievement(achieved=0, apiname='ID_25_PuyoErase50000', description='Popped 50,000 Puyos in completed matches', name='Puyo King (x50,000)', unlocktime=0), Achievement(achieved=0, apiname='ID_26_Puyo7Chain150', description='Performed a 7-Chain 150 times in completed matches', name='7-Chain Master', unlocktime=0), Achievement(achieved=0, apiname='ID_27_PuyoAllErase150', description='Performed an All Clear 150 times in completed matches', name='Screen Cleaner (x150)', unlocktime=0), Achievement(achieved=0, apiname='ID_28_PuyoErase100000', description='Popped 100,000 Puyos in completed matches', name='Puyo King (x100,000)', unlocktime=0), Achievement(achieved=1, apiname='ID_29_TetoMinoErase1000', description='Cleared 1,000 Minos in completed matches', name='Mino King (x1,000)', unlocktime=1688252641), Achievement(achieved=1, apiname='ID_30_TetoMinoErase10000', description='Cleared 10,000 Minos in completed matches', name='Mino King (x10,000)', unlocktime=1688292201), Achievement(achieved=1, apiname='ID_31_TetoTETRISx50', description='Performed a Tetris Line Clear 50 times in completed matches', name='Tetris Champ (x50)', unlocktime=1688254876), Achievement(achieved=1, apiname='ID_32_TetoTETRISx100', description='Performed a Tetris Line Clear 100 times in completed matches', name='Tetris Champ (x100)', unlocktime=1688291516), Achievement(achieved=1, apiname='ID_33_TetoB2Bx25', description='Performed a Back-to-Back 25 times in completed matches', name='Show Off (x25)', unlocktime=1688254876), Achievement(achieved=1, apiname='ID_34_TetoB2Bx50', description='Performed a Back-to-Back 50 times in completed matches', name='Show Off (x50)', unlocktime=1688292629), Achievement(achieved=1, apiname='ID_35_Teto5REN', description='Performed a 5-Combo in a completed match', name='Combo Maker', unlocktime=1688302367), Achievement(achieved=1, apiname='ID_36_Teto8REN', description='Performed an 8-Combo in a completed match', name='Combo Master', unlocktime=1688401629), Achievement(achieved=1, apiname='ID_37_TetoPERFECT1', description='Performed a Perfect Clear in a completed match', name='Perfectionist (x1)', unlocktime=1721329100), Achievement(achieved=1, apiname='ID_38_TetoPERFECT3', description='Performed a Perfect Clear 3 times in completed matches', name='Perfectionist (x3)', unlocktime=1721329241), Achievement(achieved=1, apiname='ID_39_TetoMinoErase50000', description='Cleared 50,000 Minos in completed matches', name='Mino King (x50,000)', unlocktime=1688324982), Achievement(achieved=1, apiname='ID_40_TetoTETRISx200', description='Performed a Tetris Line Clear 200 times in completed matches', name='Tetris Champ (x200)', unlocktime=1688297436), Achievement(achieved=1, apiname='ID_41_TetoB2Bx100', description='Performed a Back-to-Back 100 times in completed matches', name='Show Off (x100)', unlocktime=1688318590), Achievement(achieved=1, apiname='ID_42_TetoMinoErase100000', description='Cleared 100,000 Minos in completed matches', name='Mino King (x100,000)', unlocktime=1688456802), Achievement(achieved=0, apiname='ID_00_AllGet', description='For obtaining all trophies.', name='All Trophies Obtained', unlocktime=0)], gameName='Puyo Puyo™ Tetris® 2', steamID='XXXXXXXXXXXXXXXX', success=True)
6
'retrieve_achievements(): finish executing.'
7
'retrieve_achievements(): start executing…'
8
('400 Bad Request {"playerstats":{"error":"Requested app has no '
9
'stats","success":false}}')
10
None
11
'retrieve_achievements(): finish executing.'

Steamの情報を可視化する。#

それでは獲得したSteamの情報をWebページで表示できるようにしていきます。

まずは、FastAPIおよびPanelのパッケージをインストールします。

1
pip install FastAPI
2
pip install Panel[FastAPI]

app.pyでFastAPIのルーター的なものを実装して、panel_creator.pyで実際にSteamの情報を表示する処理を書いていきます。

src/app.py:

1
# Builtin packages
2
import os
3
# Third party packages
4
from fastapi import FastAPI
5
from panel.io.fastapi import add_applications
6
from fastapi.middleware.cors import CORSMiddleware
7
import uvicorn
8
# Local packages
9
import panel_creator
10

11
app = FastAPI()
12

13
origins = ["*"]
14
app.add_middleware(
15
    CORSMiddleware,
16
    allow_origins=origins,  # List of allowed origins
17
    allow_credentials=True,
18
    allow_methods=["*"],  # Allow all methods
19
    allow_headers=["*"],  # Allow all headers
20
)
21

22
@app.get("/")
23
async def read_root():
24
    return {"Hello": "World"}
25

26
@app.get("/steam")
27
async def read_steam():
28
    return {"Hello": "Steam"}
29

30
add_applications({
31
    "/pnl_app21": panel_creator.create_game_thumbnails()
32
}, app=app)
33

34
if __name__ == "__main__":
35
    uvicorn.run(app, host="0.0.0.0", port=int(os.environ.get("PORT", 8080)))

src/panel_creator.py:

1
# Builtin packages
2
from pprint import pprint
3
from typing import List
4
# Third party packages
5
import panel as pn
6
import numpy as np
7
import pandas as pd
8
import matplotlib.pyplot as plt
9
import matplotlib.figure
10
import datetime as dt
11
from bokeh.models import CustomJS, Slider
12
# Local packages
13
import steam
14
import config as cfg
15

16
pn.extension(comms="vscode")  # to use on VSCode
17

18
def create_game_thumbnails() -> pn.template.base.BaseTemplate.servable:
19
    steam_client = steam.get_steam_client()
20
    STEAM_ID = cfg.get_my_steam_id()
21
    games = steam.retrieve_owned_games(steam_client, STEAM_ID)
22

23
    dashboard = create_dashboard_with_html_header()
24
    def get_img_icon(game: steam.SteamGameProfile) -> pn.pane.image.Image:
25
        img_icon = f"https://avatars.akamai.steamstatic.com/{game.img_icon_url}_full.jpg"
26
        pn.pane.Image()
27
        return pn.pane.Image(img_icon, alt_text=f"{game.name}_icon", width=20, height=20)
28

29
    imgs = tuple(map(get_img_icon, games))
30
    NUMBER_OF_ICON_PER_ROW = 30
31
    def create_img_panels(elements: List[pn.pane.image.Image], number_of_icon_per_row: int) -> List[pn.layout.base.Row]:
32
        columns = []
33
        col = []
34
        for i, component in enumerate(elements):
35
            col.append(component)
36
            if (i + 1) % number_of_icon_per_row == 0:  # Create a new column per 30 components
37
                columns.append(pn.Row(*col, sizing_mode="scale_width"))
38
                col = []
39
        if col:  # Append rest components into the last column.
40
            columns.append(pn.Row(*col, sizing_mode="scale_width"))
41
        panels = pn.Column(*columns, sizing_mode="scale_width")
42
        return panels
43

44
    panels = create_img_panels(imgs, NUMBER_OF_ICON_PER_ROW)
45
    dashboard.main.append(pn.Column(*panels, sizing_mode="scale_width"))
46

47
    return dashboard.servable()
48

49
def create_dashboard_with_html_header() -> pn.template.material.MaterialTemplate:
50
    custom_header = """
51
    <link rel="icon" type="image/x-icon" href="./../static/favicon_08bit.ico">
52
    """
53

54
    # Create Panel template to append custom HTML
55
    dashboard = pn.template.MaterialTemplate(
56
        title="My Panel App",
57
        header=custom_header
58
    )
59
    return dashboard

ゲームのアイコンが一覧で取れるようになりました。

次に、src/panel_creator.py にサムネイルを一覧で取得するように実装します。

1
# Builtin packages
2
from pprint import pprint
3
from typing import List
4
# Third party packages
5
import panel as pn
6
import numpy as np
7
import pandas as pd
8
import matplotlib.pyplot as plt
9
import matplotlib.figure
10
import datetime as dt
11
from bokeh.models import CustomJS, Slider
12
# Local packages
13
import steam
14
import config as cfg
15

16
pn.extension(comms="vscode")  # to use on VSCode
17

18
@steam.function_decorator
19
def create_dashboard_with_html_header() -> pn.template.material.MaterialTemplate:
20
    custom_header = """
21
    <link rel="icon" type="image/x-icon" href="./../static/favicon_08bit.ico">
22
    """
23

24
    # Create Panel template to append custom HTML
25
    dashboard = pn.template.MaterialTemplate(
26
        title="My Panel App",
27
        header=custom_header
28
    )
29
    return dashboard
30

31
# @steam.function_decorator
32
def _get_game_img(game: steam.SteamGameProfile, img_category: str = None) -> pn.pane.image.Image:
33
    img_icon = ""
34
    width=20
35
    height=20
36
    margin=(10, 10)
37
    if img_category is None:
38
        raise ValueError("'img_category' must not be None.")
39
    elif img_category == "icon":
40
        img_icon = f"https://avatars.akamai.steamstatic.com/{game.img_icon_url}_full.jpg"
41
        # Not change width, height and margin.
42
    elif img_category == "thumbnail":
43
        img_icon = f"https://shared.fastly.steamstatic.com//store_item_assets/steam/apps/{game.appid}/library_600x900.jpg"
44
        width=200
45
        height=300
46
        margin=(0, 0)
47
    else:
48
        raise ValueError("something went wrong.")
49
    pn.pane.Image()
50
    return pn.pane.Image(img_icon, alt_text=f"{game.name}_icon", width=width, height=height, margin=margin)
51

52
@steam.function_decorator
53
def create_img_panels(elements: List[pn.pane.image.Image], number_of_icon_per_row: int, sizing_mode: str = "stretch_both") -> List[pn.layout.base.Row]:
54
    columns = []
55
    col = []
56
    for i, component in enumerate(elements):
57
        col.append(component)
58
        if (i + 1) % number_of_icon_per_row == 0:  # Create a new column per 30 components
59
            columns.append(pn.Row(*col, sizing_mode=sizing_mode, margin=(0, 0)))
60
            col = []
61
    if col:  # Append rest components into the last column.
62
        columns.append(pn.Row(*col, sizing_mode=sizing_mode, margin=(0, 0)))
63
    panels = pn.Column(*columns, sizing_mode=sizing_mode)
64
    return panels
65

66
@steam.function_decorator
67
def create_game_icons() -> pn.template.base.BaseTemplate.servable:
68
    steam_client = steam.get_steam_client()
69
    STEAM_ID = cfg.get_my_steam_id()
70
    games = steam.retrieve_owned_games(steam_client, STEAM_ID)
71

72
    dashboard = create_dashboard_with_html_header()
73
    iterable_01 = lambda x, y: [x] * len(y)
74
    imgs = tuple(map(_get_game_img, games, iterable_01("icon", games)))
75

76
    NUMBER_OF_ICON_PER_ROW = 30
77
    panels = create_img_panels(imgs, NUMBER_OF_ICON_PER_ROW, "scale_width")
78
    pprint(panels)
79
    dashboard.main.append(pn.Column(*panels, sizing_mode="scale_width"))
80

81
    return dashboard.servable()
82

83
@steam.function_decorator
84
def create_game_thumbnails() -> pn.template.base.BaseTemplate.servable:
85
    steam_client = steam.get_steam_client()
86
    STEAM_ID = cfg.get_my_steam_id()
87
    games = steam.retrieve_owned_games(steam_client, STEAM_ID)
88

89
    dashboard = create_dashboard_with_html_header()
90
    iterable_01 = lambda x, y: [x] * len(y)
91
    imgs = tuple(map(_get_game_img, games, iterable_01("thumbnail", games)))
92

93
    NUMBER_OF_ICON_PER_ROW = 12
94
    panels = create_img_panels(imgs, NUMBER_OF_ICON_PER_ROW, "stretch_both")
95
    pprint(panels)
96
    dashboard.main.append(pn.Column(*panels, sizing_mode="scale_width"))
97

98
    return dashboard.servable()
99

100

101
def create_game_achievements():
102

103
    dashboard = pn.Column(layout)
104

105
    return dashboard.servable()

今度は、ゲームのサムネイルが一覧で取れるようになりました。リンク切れになっているタイトルがチラホラあったりもします。

そして、ゲーム毎にサムネイル、タイトル、 Achievements や Stats を表示させます。

1
# Builtin packages
2
from pprint import pprint
3
from typing import List, Tuple, TypeVar
4
import functools
5
import datetime
6
# Third party packages
7
import panel as pn
8
import numpy as np
9
import pandas as pd
10
import matplotlib.pyplot as plt
11
import matplotlib.figure
12
import datetime as dt
13
from bokeh.models import CustomJS, Slider
14
from steam_web_api import Steam
15
# Local packages
16
import steam
17
import config as cfg
18

19
pn.extension(comms="vscode")
20

21
def format_from_timestamp_to_format_iso_datetime(timestamp: int, will_be_utc: bool) -> str:
22
  """
23
  Convert a Unix timestamp into an ISO 8601 formatted date string.
24

25
  :param timestamp: Unix timestamp (int or float)
26
  :param will_be_utc: Boolean representing whether the date is going to format in UTC time
27
  :type timestamp: int or float
28
  :return: ISO 8601 formatted date string or empty string if input is invalid
29
  """
30
  if not timestamp:
31
    return None
32
  if not isinstance(timestamp, (int, float)):
33
    raise ValueError("Timestamp must be an integer or float.")
34
  if will_be_utc:
35
    jst_delta = 9 * 60 * 60
36
    timestamp += jst_delta
37
  try:
38
    return datetime.datetime.fromtimestamp(timestamp).isoformat()
39
  except (ValueError, TypeError):
40
    return ""
41

42
def convert_from_iso_datetime_to_format_date_str(iso_date_string: str) -> str:
43
  """
44
  Format ISO date string into a datetime object or return an empty string.
45

46
  :param date_string: String representing a date
47
  :return: Formatted datetime object or empty string
48
  """
49
  if not iso_date_string:
50
    return None
51
  if not isinstance(iso_date_string, str):
52
    raise ValueError("ISO date string must be a string.")
53
  try:
54
    return datetime.datetime.fromisoformat(iso_date_string).strftime("%Y-%m-%d %H:%M:%S")
55
  except ValueError:
56
    return ""
57

58
def format_minutes_to_hours(minutes: int) -> str:
59
    hours = minutes // 60
60
    remaining_minutes = minutes % 60
61
    spacer = " "
62

63
    if hours > 0 and remaining_minutes > 0:
64
        return f"{hours}{spacer}hours {remaining_minutes}{spacer}minutes"
65
    elif hours > 0:
66
        return f"{hours}{spacer}hours "
67
    else:
68
        return f"{remaining_minutes}{spacer}minutes"
69

70
def _create_h2(game: steam.SteamGameProfile) -> Tuple[pn.pane.image.Image, pn.pane.Markdown]:
71
        icon  = _get_game_img(game, "icon")
72
        h2 = pn.pane.Markdown(f"## {game.name}", styles={})
73
        pprint(icon.object if icon is not None else icon)
74
        pprint(h2.object if h2 is not None else h2)
75
        return (icon, h2)
76

77
def _create_playtime(game: steam.SteamGameProfile) -> pn.pane.Markdown:
78
    iso_datetime = format_from_timestamp_to_format_iso_datetime(game.rtime_last_played, True)
79
    date_str = convert_from_iso_datetime_to_format_date_str(iso_datetime)
80
    playtime_2weeks_formatted = format_minutes_to_hours(game.playtime_2weeks) if game.playtime_2weeks is not None else game.playtime_2weeks
81
    playtime_disconnected_formatted = format_minutes_to_hours(game.playtime_disconnected) if game.playtime_disconnected is not None else game.playtime_disconnected
82
    playtime_forever_formatted = format_minutes_to_hours(game.playtime_forever) if game.playtime_forever is not None else game.playtime_forever
83
    playtime = pn.pane.Markdown(f"""
84
    | Playtime | Value |
85
    | ----------- | ----------- |
86
    | Playtime recent 2 weeks | {playtime_2weeks_formatted} |
87
    | Disconnected Playtime | {playtime_disconnected_formatted} |
88
    | Forever Playtime | {playtime_forever_formatted} |
89
    | Recent time last played | {date_str} |
90
    """, styles={})
91
    pprint(playtime.object if playtime is not None else playtime)
92
    return playtime
93

94
def _create_stats_data_info(stats_data: steam.SteamGameStatsData) -> TypeVar("T", pn.pane.Markdown, None):
95
    stats_info = None
96
    if stats_data is not None:
97
        if stats_data.stats is not None:
98
            def create_stats_value_table(a: steam.Achievement) -> str:
99
                return f"| {a.name} | {a.value} |"
100
            stats = tuple(map(create_stats_value_table, stats_data.stats))
101
            stats_info = functools.reduce(lambda a, b: f"{a}\n{b}", stats)
102
            stats_info = f"| Stat Name | Stat Value |\n| ----------- | ----------- |\n{stats_info}"
103
            stats_info = pn.pane.Markdown(stats_info)
104
    pprint(stats_info.object if stats_info is not None else stats_info)
105
    return stats_info
106

107
def _create_achievement_info(achievements: steam.SteamGameAchievements) -> Tuple[TypeVar("T", pn.pane.Markdown, None), TypeVar("T", pn.pane.Markdown, None)]:
108
    achievement_info = None
109
    description_info = None
110
    if achievements is not None:
111
        achievement_info = pn.pane.Markdown(f"""
112
        | Playtime | Value |
113
        | ----------- | ----------- |
114
        | Achievements can be retrieved | {achievements.success} |
115
        """, styles={})
116
        if achievements.achievements is not None:
117
            def create_achievement_value_table(a: steam.Achievement) -> str:
118
                iso_datetime = format_from_timestamp_to_format_iso_datetime(a.unlocktime, True)
119
                date_str = convert_from_iso_datetime_to_format_date_str(iso_datetime)
120
                return f"| {a.name} | {a.apiname} | {a.description} | {a.achieved} | {date_str} |"
121
            descriptions = tuple(map(create_achievement_value_table, achievements.achievements))
122
            description_info = functools.reduce(lambda a, b: f"{a}\n{b}", descriptions)
123
            description_info = f"| Achievement Name | Achievement API Name | Description | Is Achieved | Unlock Time |\n| ----------- | ----------- | ----------- | ----------- | ----------- |\n{description_info}"
124
            description_info = pn.pane.Markdown(description_info)
125
    pprint(achievement_info.object if achievement_info is not None else achievement_info)
126
    pprint(description_info.object if description_info is not None else description_info)
127
    return (achievement_info, description_info)
128

129
def _get_game_detail(game: steam.SteamGameProfile, steam_client: Steam, STEAM_ID: str) -> pn.layout.base.Column:
130
    # Retrieve game data to show
131
    game_data = steam.retrieve_game_data(steam_client, STEAM_ID, game.appid)
132
    achievements = steam.retrieve_achievements(steam_client, STEAM_ID, game.appid)
133

134
    # Create Heading 2
135
    (icon, h2) = _create_h2(game)
136
    # Create playtime info
137
    playtime = _create_playtime(game)
138
    # Create achievement info
139
    (achievement_info, description_info) = _create_achievement_info(achievements)
140
    # Create stat info
141
    stats_data = _create_stats_data_info(game_data)
142
    # Create image
143
    thumbnail = _get_game_img(game, "thumbnail")
144

145
    # Create layout in the panel
146
    row1 = pn.Row(icon, h2, margin=(0, 0))
147
    row2_2 = pn.Column(achievement_info, description_info)
148
    row2_3 = pn.Row(stats_data)
149
    row2 = pn.Row(thumbnail, playtime, row2_2, row2_3)
150
    result = pn.Column(row1, row2)
151
    return result
152

153
@steam.function_decorator
154
def create_game_details() -> pn.template.base.BaseTemplate.servable:
155
    my_steam_client = steam.get_steam_client()
156
    MY_STEAM_ID = cfg.get_my_steam_id()
157
    games = steam.retrieve_owned_games(my_steam_client, MY_STEAM_ID)
158

159
    dashboard = create_dashboard_with_html_header()
160
    iterable_01 = lambda x, y: [x] * len(y)
161

162
    # games = games[:4] # tmp TODO
163
    game_details = tuple(map(_get_game_detail, games, iterable_01(my_steam_client, games), iterable_01(MY_STEAM_ID, games)))
164
    dashboard.main.append(pn.Column(*game_details, sizing_mode="scale_width"))
165
    return dashboard.servable()

panel.pane.Markdownのクラスを使って、ゲームのAchievementsを表示させることが出来ました。

同様に、ゲームのStatsも右の方に表示することが出来ました。PanelではMarkdownを書けるのが便利ですね。

まあ、上記のコードだと処理が直列になっているので、並行もしくは並列化したいですね。とりあえず今回はこんなところで終わっておきます・・・。

まとめ#

今回は、Pythonを使って、matplotlibでプロットしたチャートを、FastAPIおよびPanelでWebページとして表示するツールを作る流れを紹介しました。

以下、本記事のまとめです。

python-steam-apiパッケージの方が、Steam Web APIよりもレスポンスの情報が整理されている。
python-steam-apiで、ユーザーの基本情報や所持しているゲームの情報を取得することが出来る。
PanelではMarkdownを使ってページの描画を制御できる。

今回、プロットするための情報があまり無かったのでグラフは作りませんでした。なぜなら、python-steam-apiで時系列データを取得できなかったからです。これに関しては、毎月のタイミングとかでデータを取得するしかないですかね。データが貯まったらプロットしたチャートも映してみたいです。

ゲームとプログラミングのお供に#

おしまい#