chzzk-python 0.8.0__tar.gz → 0.9.0__tar.gz

chzzk_python-0.9.0/.env.example

@@ -0,0 +1,46 @@
+# Chzzk CLI Configuration
+# Copy this file to .env and fill in your values
+
+# Authentication (Naver Cookie)
+# 브라우저에서 네이버 로그인 후 개발자 도구에서 쿠키 확인
+# 1. 브라우저에서 chzzk.naver.com에 로그인
+# 2. 개발자 도구 (F12) -> Application -> Cookies -> chzzk.naver.com
+# 3. NID_AUT와 NID_SES 값을 복사
+CHZZK_NID_AUT=
+CHZZK_NID_SES=
+
+# Logging Configuration
+# Log level: DEBUG, INFO, WARNING, ERROR
+CHZZK_LOG_LEVEL=WARNING
+
+# Log file path (optional)
+CHZZK_LOG_FILE=
+
+# Disable console (stderr) logging output (set to 1 to disable)
+CHZZK_NO_CONSOLE_LOG=
+
+# Chat Format Configuration (Rich markup supported)
+# Available variables: {time}, {server_time}, {badge}, {verified}, {role}, {name}, {msg}
+# Example: "{time} {badge}{verified}{name}: {msg}"
+CHZZK_CHAT_FORMAT=
+
+# Donation Format (Rich markup supported)
+# Available variables: {time}, {server_time}, {badge}, {verified}, {role}, {name}, {msg}, {amount}, {pay_type}, {donation_type}, {continuous_days}
+# Example: "{time} {amount}원({pay_type}) {badge}{name}: {msg}"
+CHZZK_DONATION_FORMAT=
+
+# Sent Message Format (Rich markup supported)
+# Available variables: {time}, {msg}
+# Example: "{time} > {msg}"
+CHZZK_SENT_FORMAT=
+
+# Time format (strftime format string)
+# Example: "%H:%M:%S" (24-hour), "%I:%M:%S %p" (12-hour with AM/PM)
+CHZZK_TIME_FORMAT=
+
+# Chat Output Configuration
+# Save chat messages to file
+CHZZK_CHAT_OUTPUT=
+
+# Output format: jsonl, txt (default: jsonl)
+CHZZK_CHAT_OUTPUT_FORMAT=

{chzzk_python-0.8.0 → chzzk_python-0.9.0}/.github/workflows/ci.yml

@@ -24,7 +24,7 @@ jobs:
           python-version: "3.12"
 
       - name: Install dependencies
-        run: uv sync --dev
+        run: uv sync --dev --all-extras
 
       - name: Run ruff format check
         run: uv run ruff format --check .
@@ -53,7 +53,7 @@ jobs:
           python-version: ${{ matrix.python-version }}
 
       - name: Install dependencies
-        run: uv sync --dev
+        run: uv sync --dev --all-extras
 
       - name: Run tests
         run: uv run pytest -v

{chzzk_python-0.8.0 → chzzk_python-0.9.0}/.github/workflows/publish.yml

@@ -1,8 +1,9 @@
 name: Publish to PyPI
 
 on:
-  release:
-    types: [published]
+  push:
+    tags:
+      - "v*"
   workflow_dispatch:
 
 jobs:
@@ -36,9 +37,42 @@ jobs:
           name: dist
           path: dist/
 
-  publish-pypi:
+  release:
     needs: build
     runs-on: ubuntu-latest
+    if: startsWith(github.ref, 'refs/tags/v')
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - name: Generate changelog
+        uses: orhun/git-cliff-action@v4
+        with:
+          config: github
+          args: --latest --strip header
+        env:
+          OUTPUT: CHANGES.md
+          GITHUB_REPO: ${{ github.repository }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Create Release
+        uses: softprops/action-gh-release@v2
+        with:
+          body_path: CHANGES.md
+          files: dist/*
+
+  publish-pypi:
+    needs: release
+    runs-on: ubuntu-latest
     environment:
       name: pypi
       url: https://pypi.org/p/chzzk-python

{chzzk_python-0.8.0 → chzzk_python-0.9.0}/.gitignore

@@ -41,3 +41,5 @@ htmlcov/
 CLAUDE.md
 .claude/
 
+*.log
+*.txt

{chzzk_python-0.8.0 → chzzk_python-0.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: chzzk-python
-Version: 0.8.0
+Version: 0.9.0
 Summary: Unofficial Python SDK for Chzzk (NAVER Live Streaming Platform) API
 Project-URL: Homepage, https://github.com/hypn4/chzzk-python
 Project-URL: Repository, https://github.com/hypn4/chzzk-python

{chzzk_python-0.8.0 → chzzk_python-0.9.0}/docs/unofficial-chat-websocket-protocol.md

@@ -1,6 +1,6 @@
 # Chzzk 비공식 채팅 WebSocket 프로토콜 분석
 
-> 최종 업데이트: 2026-01-23
+> 최종 업데이트: 2026-01-25
 > 분석 방법: Chrome DevTools WebSocket 메시지 캡처
 
 ## 개요
@@ -255,6 +255,174 @@ GET https://api.chzzk.naver.com/service/v1/user/status
 
 ---
 
+## 수신 메시지 구조
+
+### 6. CHAT (cmd: 93101)
+
+실시간 채팅 메시지 수신.
+
+```json
+{
+  "ver": "3",
+  "cmd": 93101,
+  "svcid": "game",
+  "cid": "N2FOy2",
+  "bdy": [
+    {
+      "svcid": "game",
+      "cid": "N2FOy2",
+      "mbrCnt": 1234,
+      "uid": "14f67c97d654f655afc0c9b3********",
+      "profile": "{\"userIdHash\":\"14f67c97...\",\"nickname\":\"닉네임\",\"profileImageUrl\":\"...\",\"userRoleCode\":\"common_user\",\"badge\":null,\"title\":null,\"verifiedMark\":false,\"activityBadges\":[{\"badgeNo\":123,\"badgeId\":\"구독자\",\"name\":\"구독자\",\"imageUrl\":\"...\"}],\"streamingProperty\":{}}",
+      "msg": "안녕하세요!",
+      "msgTypeCode": 1,
+      "msgStatusType": "NORMAL",
+      "extras": "{\"chatType\":\"STREAMING\",\"osType\":\"PC\",\"emojis\":{}}",
+      "ctime": 1769139665965,
+      "utime": 1769139665965,
+      "msgTime": 1769139665965
+    }
+  ]
+}
+```
+
+**bdy 배열 내 메시지 필드:**
+
+| 필드 | 설명 |
+|------|------|
+| `uid` | 사용자 ID 해시 |
+| `profile` | 사용자 프로필 (JSON 문자열, 아래 참조) |
+| `msg` | 메시지 내용 |
+| `msgTypeCode` | 메시지 타입 (`1` = 일반 텍스트, `10` = 후원 메시지) |
+| `msgStatusType` | 메시지 상태 (`NORMAL`, `HIDDEN` 등) |
+| `extras` | 추가 데이터 (JSON 문자열) |
+| `ctime` | 생성 시간 (밀리초) |
+| `msgTime` | 메시지 시간 (밀리초) |
+| `mbrCnt` | 현재 시청자 수 |
+
+### 7. DONATION (cmd: 93102)
+
+후원 메시지 수신.
+
+```json
+{
+  "ver": "3",
+  "cmd": 93102,
+  "svcid": "game",
+  "cid": "N2FOy2",
+  "bdy": [
+    {
+      "uid": "14f67c97d654f655afc0c9b3********",
+      "profile": "{...}",
+      "msg": "응원합니다!",
+      "msgTypeCode": 10,
+      "msgStatusType": "NORMAL",
+      "extras": "{\"payType\":\"CURRENCY\",\"payAmount\":1000,\"donationType\":\"CHAT\",...}",
+      "msgTime": 1769139665965
+    }
+  ]
+}
+```
+
+**중요**: 후원 관련 필드(`payType`, `payAmount`, `donationType`)는 **`extras` JSON 문자열 내부**에 있습니다. 최상위 필드가 아닙니다.
+
+**extras 필드 파싱 후 전체 구조:**
+
+```json
+{
+  "emojis": {},
+  "streamingChannelId": "a9b3377345a2a37e68a6072ba5e77fec",
+  "donationId": "6alUxGqGBsQvsGNE1eoa0lV9JGEBl",
+  "donationType": "CHAT",
+  "payType": "CURRENCY",
+  "payAmount": 1000,
+  "nickname": "닉네임",
+  "osType": "PC",
+  "chatType": "STREAMING",
+  "isAnonymous": false,
+  "continuousDonationDays": 1,
+  "weeklyRankList": [...],
+  "donationUserWeeklyRank": {...}
+}
+```
+
+**extras 필드 내 DONATION 전용 필드:**
+
+| 필드 | 타입 | 설명 |
+|------|------|------|
+| `payType` | string | 결제 타입 (`CURRENCY` = 치즈, `CHEESE` 등) |
+| `payAmount` | int | 결제 금액 (KRW, 정수) |
+| `donationType` | string | 후원 타입 (`CHAT`, `VIDEO` 등) |
+| `donationId` | string | 후원 고유 ID |
+| `isAnonymous` | boolean | 익명 여부 |
+| `nickname` | string | 후원자 닉네임 (extras 내에도 포함) |
+| `continuousDonationDays` | int | 연속 후원 일수 |
+| `weeklyRankList` | array | 주간 후원 랭킹 목록 (상위 10명) |
+| `donationUserWeeklyRank` | object | 후원자의 주간 랭킹 정보 |
+
+---
+
+## profile 필드 구조
+
+`profile` 필드는 JSON 문자열로 인코딩되어 있으며, 파싱 후 다음 구조를 가짐:
+
+```json
+{
+  "userIdHash": "14f67c97d654f655afc0c9b3********",
+  "nickname": "닉네임",
+  "profileImageUrl": "https://...",
+  "userRoleCode": "common_user",
+  "badge": null,
+  "title": null,
+  "verifiedMark": false,
+  "activityBadges": [
+    {
+      "badgeNo": 1708498,
+      "badgeId": "donation_accumulate_amount_lv1",
+      "name": "치즈 후원자",
+      "imageUrl": "https://ssl.pstatic.net/static/nng/glive/icon/cheese01.png",
+      "activated": true
+    }
+  ],
+  "streamingProperty": {
+    "nicknameColor": {"colorCode": "CC000"},
+    "activatedAchievementBadgeIds": []
+  },
+  "viewerBadges": [
+    {
+      "type": "STANDARD",
+      "badge": {
+        "badgeId": "donation_accumulate_amount_lv1",
+        "scope": "CHANNEL",
+        "imageUrl": "https://ssl.pstatic.net/static/nng/glive/badge/recent_cheese01.png"
+      }
+    }
+  ]
+}
+```
+
+**주요 필드 설명:**
+
+| 필드 | 타입 | 설명 |
+|------|------|------|
+| `userIdHash` | string | 사용자 ID 해시 |
+| `nickname` | string | 닉네임 |
+| `profileImageUrl` | string | 프로필 이미지 URL |
+| `userRoleCode` | string | 권한 코드 (`common_user`, `streamer`, `manager` 등) |
+| `badge` | object \| null | 대표 배지 (`name`, `imageUrl` 등) |
+| `title` | object \| null | 칭호 (`name`, `color` 등) |
+| `verifiedMark` | boolean | 인증 마크 여부 |
+| `activityBadges` | array | 활동 배지 목록 (구독, 후원 레벨 등) |
+| `streamingProperty` | object | 스트리밍 속성 (닉네임 색상 등) |
+| `viewerBadges` | array | 시청자 배지 목록 (채널별/글로벌 배지) |
+
+**참고**: `badge`와 `activityBadges`는 서로 다른 필드입니다:
+- `badge`: 단일 대표 배지 (스트리머가 지정한 배지, 대부분 null)
+- `activityBadges`: 활동 기반 배지 목록 (구독자, 후원 레벨 등)
+- `viewerBadges`: 시청자 배지 (채널/글로벌 스코프)
+
+---
+
 ## 주의사항
 
 1. **프로토콜 버전**: 모든 메시지에 `"ver": "3"` 사용
@@ -269,4 +437,5 @@ GET https://api.chzzk.naver.com/service/v1/user/status
 
 | 날짜 | 변경 내용 |
 |------|----------|
+| 2026-01-25 | CHAT/DONATION 메시지 구조 추가, profile 필드 상세 문서화 |
 | 2026-01-23 | 최초 작성. Chrome DevTools WebSocket 캡처 기반 프로토콜 분석 |

{chzzk_python-0.8.0 → chzzk_python-0.9.0}/src/chzzk/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.8.0'
-__version_tuple__ = version_tuple = (0, 8, 0)
+__version__ = version = '0.9.0'
+__version_tuple__ = version_tuple = (0, 9, 0)
 
 __commit_id__ = commit_id = None