chzzk-python 0.1.0__tar.gz → 0.6.0__tar.gz

{chzzk_python-0.1.0 → chzzk_python-0.6.0}/.github/workflows/ci.yml

@@ -5,6 +5,7 @@ on:
     branches: [main]
   pull_request:
     branches: [main]
+  workflow_call:
 
 jobs:
   lint:

{chzzk_python-0.1.0 → chzzk_python-0.6.0}/.github/workflows/publish.yml

@@ -1,15 +1,21 @@
 name: Publish to PyPI
 
 on:
-  push:
-    tags:
-      - 'v*'
+  release:
+    types: [published]
+  workflow_dispatch:
 
 jobs:
+  ci:
+    uses: ./.github/workflows/ci.yml
+
   build:
+    needs: ci
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
 
       - name: Install uv
         uses: astral-sh/setup-uv@v7
@@ -30,28 +36,8 @@ jobs:
           name: dist
           path: dist/
 
-  publish-testpypi:
-    needs: build
-    runs-on: ubuntu-latest
-    environment:
-      name: testpypi
-      url: https://test.pypi.org/p/chzzk-python
-    permissions:
-      id-token: write
-    steps:
-      - name: Download artifacts
-        uses: actions/download-artifact@v4
-        with:
-          name: dist
-          path: dist/
-
-      - name: Publish to TestPyPI
-        uses: pypa/gh-action-pypi-publish@release/v1
-        with:
-          repository-url: https://test.pypi.org/legacy/
-
   publish-pypi:
-    needs: publish-testpypi
+    needs: build
     runs-on: ubuntu-latest
     environment:
       name: pypi

chzzk_python-0.6.0/.github/workflows/release-please.yml

@@ -0,0 +1,18 @@
+name: Release Please
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: googleapis/release-please-action@v4
+        with:
+          release-type: python

chzzk_python-0.6.0/CHANGELOG.md

@@ -0,0 +1,154 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.6.0](https://github.com/hypn4/chzzk-python/compare/v0.5.0...v0.6.0) (2026-01-23)
+
+
+### Features
+
+* **ci:** add workflow_dispatch trigger for manual publish ([db81d8a](https://github.com/hypn4/chzzk-python/commit/db81d8a8451dea15cd3e09eb658020f1ebb32f66))
+
+
+### Bug Fixes
+
+* **ci:** change publish trigger to release event ([984df49](https://github.com/hypn4/chzzk-python/commit/984df49fdd67c52096c74ddcc140eacdfc8148bf))
+
+## [0.5.0](https://github.com/hypn4/chzzk-python/compare/v0.4.2...v0.5.0) (2026-01-23)
+
+
+### Features
+
+* **ci:** add workflow_call trigger to CI workflow ([c7d016e](https://github.com/hypn4/chzzk-python/commit/c7d016e69a3af6cb79daf9fb1c528fd68c340861))
+* **ci:** improve publish workflow reliability and trigger mechanism ([640b857](https://github.com/hypn4/chzzk-python/commit/640b857ac0033211bbf6bd3f35d82c242d0b8050))
+
+## [0.4.2](https://github.com/hypn4/chzzk-python/compare/v0.4.1...v0.4.2) (2026-01-23)
+
+
+### Bug Fixes
+
+* **ci:** fetch all tags in publish workflow for hatch-vcs ([2b27204](https://github.com/hypn4/chzzk-python/commit/2b2720487a74d59ce563c1663f42520489f5d3cd))
+
+## [0.4.1](https://github.com/hypn4/chzzk-python/compare/v0.4.0...v0.4.1) (2026-01-23)
+
+
+### Bug Fixes
+
+* **ci:** remove workflow_dispatch from publish workflow ([878def8](https://github.com/hypn4/chzzk-python/commit/878def8daa0aa582c0abe2b17d4d9408c5471ac5))
+
+## [0.4.0](https://github.com/hypn4/chzzk-python/compare/v0.3.1...v0.4.0) (2026-01-23)
+
+
+### Features
+
+* **api:** add live status polling service ([5cede05](https://github.com/hypn4/chzzk-python/commit/5cede05360d4eb7b0c82d3939cf9577648307692))
+* **chat:** add offline channel connection support ([5d63c34](https://github.com/hypn4/chzzk-python/commit/5d63c343786ce8d56be1676d298e5c9f3d4bc244))
+* **chat:** add status monitoring and auto-reconnection ([6a77361](https://github.com/hypn4/chzzk-python/commit/6a77361f964015612266e3662c422904a8c9b16a))
+* **cli:** add CLI module with auth, live, and chat commands ([98e3741](https://github.com/hypn4/chzzk-python/commit/98e37417a2bc9cb353d772037f73c81c3907e01b))
+* **cli:** add CLI optional dependencies ([4cd1ca0](https://github.com/hypn4/chzzk-python/commit/4cd1ca0ccffd3b7dcc31984e0a17aceb3afc6480))
+* **cli:** add interactive chat mode and offline support ([f6e173b](https://github.com/hypn4/chzzk-python/commit/f6e173b9f4abbcc4e8d2bcf3233ac126c20ccb7f))
+* **exceptions:** add ChatReconnectError for reconnection failures ([a83a21d](https://github.com/hypn4/chzzk-python/commit/a83a21dd2a3b6a9e3ef274a8d98908e6dcfaaf35))
+* **models:** add reconnection event models ([3d98b38](https://github.com/hypn4/chzzk-python/commit/3d98b387bdc1d09556d8eaee28277c7a6cf5b5f0))
+
+
+### Bug Fixes
+
+* **api:** update live detail endpoint to v3.3 ([0fc935b](https://github.com/hypn4/chzzk-python/commit/0fc935bc718124775ba6cc6198279d9909ba25aa))
+
+
+### Documentation
+
+* add CLI documentation to README ([348a2b7](https://github.com/hypn4/chzzk-python/commit/348a2b76ab47a79018010064db66fbd73c6347f1))
+* **cli:** document interactive and offline chat flags ([b50f7a1](https://github.com/hypn4/chzzk-python/commit/b50f7a19fcad39ed110f963cab29300773b1ee01))
+
+## [0.3.1](https://github.com/hypn4/chzzk-python/compare/v0.3.0...v0.3.1) (2026-01-23)
+
+
+### Bug Fixes
+
+* **ci:** add skip-existing to PyPI publish workflow ([84cce48](https://github.com/hypn4/chzzk-python/commit/84cce48))
+
+## [0.3.0](https://github.com/hypn4/chzzk-python/compare/v0.2.0...v0.3.0) (2026-01-23)
+
+
+### Features
+
+* add unofficial API with Naver cookie authentication ([2481223](https://github.com/hypn4/chzzk-python/commit/2481223672b56c2de102d42fc4f17e7420e9df7a))
+
+
+### Bug Fixes
+
+* **ci:** trigger publish workflow from release-please ([d63302a](https://github.com/hypn4/chzzk-python/commit/d63302a61e683c73246e5fbd62b7e55cd7bfdd02))
+
+
+### Documentation
+
+* add unofficial API documentation to README ([0c7d575](https://github.com/hypn4/chzzk-python/commit/0c7d5756c6905ec9c4fa2715ffc3655516f9c1e3))
+* add unofficial chat WebSocket protocol documentation ([bb2d4d3](https://github.com/hypn4/chzzk-python/commit/bb2d4d3d6fd058d365d8051169ba3318bdbc5c64))
+* **examples:** add unofficial chat client examples ([8b68a41](https://github.com/hypn4/chzzk-python/commit/8b68a41964588ef40d4a5ce9cdd9bc4080cd5c09))
+
+## [0.2.0](https://github.com/hypn4/chzzk-python/compare/v0.1.0...v0.2.0) (2026-01-23)
+
+
+### Features
+
+* **ci:** add Release Please workflow for automated releases ([34be227](https://github.com/hypn4/chzzk-python/commit/34be227f6f75fe769f0a3760673520487b7dd004))
+
+## [Unreleased]
+
+### Added
+
+- **exceptions**: Add custom exception classes for Chzzk SDK
+- **http**: Add HTTP client wrapper for Chzzk API
+- **auth**: Add OAuth authentication models
+- **auth**: Add token storage implementations
+- **auth**: Add OAuth client implementations
+- **examples**: Add OAuth authorization code flow example
+- **examples**: Enhance OAuth server with ChzzkClient and API demos
+- **http**: Add PUT, PATCH, and DELETE methods to HTTP clients
+- **http**: Add Open API endpoint constants
+- **models**: Add Pydantic models for Chzzk API responses
+- **api**: Implement service layer for Chzzk Open API
+- **client**: Add unified Chzzk API client
+- Export client, services, and models from package root
+- **http**: Add params support to POST methods
+- **models**: Add session and realtime event models
+- **http**: Add session API endpoints
+- **exceptions**: Add session-related exceptions
+- **api**: Implement session service for WebSocket management
+- **realtime**: Add Socket.IO client for realtime events
+- **client**: Integrate session service and event client
+- Export session, realtime, and related components
+- **examples**: Add session list endpoint to OAuth server
+- **examples**: Add realtime and session management examples
+
+### Build
+
+- Add python-socketio dependency for realtime events
+- Add websocket-client dependency
+- Exclude AI tooling files from git and distribution
+
+### Changed
+
+- **auth**: Remove get_access_token method from OAuth classes
+
+### Documentation
+
+- Add comprehensive SDK documentation
+
+### Fixed
+
+- **http**: Extract content field from Chzzk API response wrapper
+- **realtime**: Handle string and dict event data from Socket.IO
+- **models**: Make user_role_code optional in ChatEvent
+
+### Testing
+
+- **auth**: Add comprehensive OAuth test suite
+- Add comprehensive test suite for API services and client
+- Add tests for session service and realtime client
+
+[Unreleased]: https://github.com/hypn4/chzzk-python/compare/...HEAD

{chzzk_python-0.1.0 → chzzk_python-0.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: chzzk-python
-Version: 0.1.0
+Version: 0.6.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
@@ -26,6 +26,10 @@ Requires-Dist: httpx>=0.28.0
 Requires-Dist: pydantic>=2.10.0
 Requires-Dist: python-socketio[asyncio-client]<5.0.0,>=4.6.0
 Requires-Dist: websocket-client>=1.9.0
+Requires-Dist: websockets>=12.0
+Provides-Extra: cli
+Requires-Dist: rich>=13.0.0; extra == 'cli'
+Requires-Dist: typer>=0.15.0; extra == 'cli'
 Description-Content-Type: text/markdown
 
 # chzzk-python
@@ -47,6 +51,16 @@ uv add chzzk-python
 pip install chzzk-python
 ```
 
+### CLI Installation
+
+```bash
+# Using uv (recommended)
+uv add "chzzk-python[cli]"
+
+# Using pip
+pip install "chzzk-python[cli]"
+```
+
 ## Quick Start
 
 ```python
@@ -87,6 +101,8 @@ print(f"Channel: {user.channel_name}")
 | **Drops** | ❌ Not Implemented | - |
 | **Webhook Event** | ❌ Not Implemented | - |
 
+> A [CLI](#command-line-interface) is also available for quick terminal access.
+
 ## Features
 
 ### Sync/Async Support
@@ -288,6 +304,148 @@ except ChzzkAPIError as e:
     print(f"API Error: [{e.status_code}] {e.error_code}: {e.message}")
 ```
 
+## Unofficial API
+
+In addition to the official API, we provide an unofficial API using Naver cookie authentication.
+This enables real-time chat receiving/sending functionality.
+
+> ⚠️ The unofficial API may change at any time and is not officially supported.
+
+### Unofficial Chat Client
+
+**Synchronous version:**
+
+```python
+from chzzk.unofficial import UnofficialChatClient, ChatMessage
+
+chat = UnofficialChatClient(
+    nid_aut="your-nid-aut-cookie",
+    nid_ses="your-nid-ses-cookie",
+)
+
+@chat.on_chat
+def on_chat(msg: ChatMessage):
+    print(f"{msg.nickname}: {msg.content}")
+
+@chat.on_donation
+def on_donation(msg):
+    print(f"{msg.nickname} donated {msg.pay_amount}won")
+
+chat.connect("channel-id")
+chat.send_message("Hello!")
+chat.run_forever()
+```
+
+**Asynchronous version:**
+
+```python
+from chzzk.unofficial import AsyncUnofficialChatClient, ChatMessage
+
+async with AsyncUnofficialChatClient(
+    nid_aut="your-nid-aut-cookie",
+    nid_ses="your-nid-ses-cookie",
+) as chat:
+    @chat.on_chat
+    async def on_chat(msg: ChatMessage):
+        print(f"{msg.nickname}: {msg.content}")
+
+    await chat.connect("channel-id")
+    await chat.send_message("Hello!")
+    await chat.run_forever()
+```
+
+### How to Get Naver Cookies
+
+1. Log in to Naver
+2. Browser Developer Tools (F12) → Application → Cookies
+3. Copy `NID_AUT` and `NID_SES` cookie values
+
+### Unofficial API Exception Handling
+
+```python
+from chzzk import ChatConnectionError, ChatNotLiveError
+
+try:
+    chat.connect("channel-id")
+except ChatNotLiveError:
+    print("Channel is not currently live")
+except ChatConnectionError as e:
+    print(f"Connection failed: {e}")
+```
+
+## Command Line Interface
+
+A CLI is available for quick access to the unofficial API features.
+
+### Authentication
+
+```bash
+# Save your Naver cookies (interactive)
+chzzk auth login
+
+# Check authentication status
+chzzk auth status
+
+# Remove stored cookies
+chzzk auth logout
+```
+
+Cookies are stored in `~/.chzzk/cookies.json`.
+
+### Live Status
+
+```bash
+# Get detailed live information
+chzzk live info CHANNEL_ID
+
+# Get simple LIVE/OFFLINE status
+chzzk live status CHANNEL_ID
+
+# JSON output
+chzzk --json live info CHANNEL_ID
+```
+
+### Chat
+
+```bash
+# Watch real-time chat
+chzzk chat watch CHANNEL_ID
+
+# Watch chat even when offline
+chzzk chat watch CHANNEL_ID --offline
+
+# Send a single message (requires authentication)
+chzzk chat send CHANNEL_ID "Hello!"
+
+# Send to offline channel
+chzzk chat send CHANNEL_ID "Hello!" --offline
+
+# Interactive mode: send and receive messages
+chzzk chat send CHANNEL_ID --interactive
+# or
+chzzk chat send CHANNEL_ID -i
+
+# Interactive mode with offline channel
+chzzk chat send CHANNEL_ID -i --offline
+```
+
+### Global Options
+
+```bash
+--nid-aut TEXT      # Override NID_AUT cookie (env: CHZZK_NID_AUT)
+--nid-ses TEXT      # Override NID_SES cookie (env: CHZZK_NID_SES)
+--json              # Output in JSON format
+--log-level LEVEL   # Set log level (DEBUG, INFO, WARNING, ERROR)
+```
+
+### Environment Variables
+
+| Variable | Description |
+|----------|-------------|
+| `CHZZK_NID_AUT` | NID_AUT cookie value |
+| `CHZZK_NID_SES` | NID_SES cookie value |
+| `CHZZK_LOG_LEVEL` | Default log level |
+
 ## Examples
 
 See the [examples](examples/) directory for complete working examples:
@@ -296,6 +454,8 @@ See the [examples](examples/) directory for complete working examples:
 - `realtime_chat.py` - Realtime chat/donation/subscription events (sync)
 - `realtime_chat_async.py` - Realtime events (async)
 - `session_management.py` - Session management example
+- `unofficial_chat.py` - Unofficial chat client (sync)
+- `unofficial_chat_async.py` - Unofficial chat client (async)
 
 ## API Reference
 

{chzzk_python-0.1.0 → chzzk_python-0.6.0}/README.md

@@ -17,6 +17,16 @@ uv add chzzk-python
 pip install chzzk-python
 ```
 
+### CLI Installation
+
+```bash
+# Using uv (recommended)
+uv add "chzzk-python[cli]"
+
+# Using pip
+pip install "chzzk-python[cli]"
+```
+
 ## Quick Start
 
 ```python
@@ -57,6 +67,8 @@ print(f"Channel: {user.channel_name}")
 | **Drops** | ❌ Not Implemented | - |
 | **Webhook Event** | ❌ Not Implemented | - |
 
+> A [CLI](#command-line-interface) is also available for quick terminal access.
+
 ## Features
 
 ### Sync/Async Support
@@ -258,6 +270,148 @@ except ChzzkAPIError as e:
     print(f"API Error: [{e.status_code}] {e.error_code}: {e.message}")
 ```
 
+## Unofficial API
+
+In addition to the official API, we provide an unofficial API using Naver cookie authentication.
+This enables real-time chat receiving/sending functionality.
+
+> ⚠️ The unofficial API may change at any time and is not officially supported.
+
+### Unofficial Chat Client
+
+**Synchronous version:**
+
+```python
+from chzzk.unofficial import UnofficialChatClient, ChatMessage
+
+chat = UnofficialChatClient(
+    nid_aut="your-nid-aut-cookie",
+    nid_ses="your-nid-ses-cookie",
+)
+
+@chat.on_chat
+def on_chat(msg: ChatMessage):
+    print(f"{msg.nickname}: {msg.content}")
+
+@chat.on_donation
+def on_donation(msg):
+    print(f"{msg.nickname} donated {msg.pay_amount}won")
+
+chat.connect("channel-id")
+chat.send_message("Hello!")
+chat.run_forever()
+```
+
+**Asynchronous version:**
+
+```python
+from chzzk.unofficial import AsyncUnofficialChatClient, ChatMessage
+
+async with AsyncUnofficialChatClient(
+    nid_aut="your-nid-aut-cookie",
+    nid_ses="your-nid-ses-cookie",
+) as chat:
+    @chat.on_chat
+    async def on_chat(msg: ChatMessage):
+        print(f"{msg.nickname}: {msg.content}")
+
+    await chat.connect("channel-id")
+    await chat.send_message("Hello!")
+    await chat.run_forever()
+```
+
+### How to Get Naver Cookies
+
+1. Log in to Naver
+2. Browser Developer Tools (F12) → Application → Cookies
+3. Copy `NID_AUT` and `NID_SES` cookie values
+
+### Unofficial API Exception Handling
+
+```python
+from chzzk import ChatConnectionError, ChatNotLiveError
+
+try:
+    chat.connect("channel-id")
+except ChatNotLiveError:
+    print("Channel is not currently live")
+except ChatConnectionError as e:
+    print(f"Connection failed: {e}")
+```
+
+## Command Line Interface
+
+A CLI is available for quick access to the unofficial API features.
+
+### Authentication
+
+```bash
+# Save your Naver cookies (interactive)
+chzzk auth login
+
+# Check authentication status
+chzzk auth status
+
+# Remove stored cookies
+chzzk auth logout
+```
+
+Cookies are stored in `~/.chzzk/cookies.json`.
+
+### Live Status
+
+```bash
+# Get detailed live information
+chzzk live info CHANNEL_ID
+
+# Get simple LIVE/OFFLINE status
+chzzk live status CHANNEL_ID
+
+# JSON output
+chzzk --json live info CHANNEL_ID
+```
+
+### Chat
+
+```bash
+# Watch real-time chat
+chzzk chat watch CHANNEL_ID
+
+# Watch chat even when offline
+chzzk chat watch CHANNEL_ID --offline
+
+# Send a single message (requires authentication)
+chzzk chat send CHANNEL_ID "Hello!"
+
+# Send to offline channel
+chzzk chat send CHANNEL_ID "Hello!" --offline
+
+# Interactive mode: send and receive messages
+chzzk chat send CHANNEL_ID --interactive
+# or
+chzzk chat send CHANNEL_ID -i
+
+# Interactive mode with offline channel
+chzzk chat send CHANNEL_ID -i --offline
+```
+
+### Global Options
+
+```bash
+--nid-aut TEXT      # Override NID_AUT cookie (env: CHZZK_NID_AUT)
+--nid-ses TEXT      # Override NID_SES cookie (env: CHZZK_NID_SES)
+--json              # Output in JSON format
+--log-level LEVEL   # Set log level (DEBUG, INFO, WARNING, ERROR)
+```
+
+### Environment Variables
+
+| Variable | Description |
+|----------|-------------|
+| `CHZZK_NID_AUT` | NID_AUT cookie value |
+| `CHZZK_NID_SES` | NID_SES cookie value |
+| `CHZZK_LOG_LEVEL` | Default log level |
+
 ## Examples
 
 See the [examples](examples/) directory for complete working examples:
@@ -266,6 +420,8 @@ See the [examples](examples/) directory for complete working examples:
 - `realtime_chat.py` - Realtime chat/donation/subscription events (sync)
 - `realtime_chat_async.py` - Realtime events (async)
 - `session_management.py` - Session management example
+- `unofficial_chat.py` - Unofficial chat client (sync)
+- `unofficial_chat_async.py` - Unofficial chat client (async)
 
 ## API Reference