initial commit

Author: jonghwanhyeon

.gitignore

@@ -0,0 +1,209 @@
+# Created by https://www.toptal.com/developers/gitignore/api/python,macos
+# Edit at https://www.toptal.com/developers/gitignore?templates=python,macos
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### macOS Patch ###
+# iCloud generated files
+*.icloud
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+### Python Patch ###
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+poetry.toml
+
+# ruff
+.ruff_cache/
+
+# LSP config files
+pyrightconfig.json
+
+# End of https://www.toptal.com/developers/gitignore/api/python,macos

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Jonghwan Hyeon
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,35 @@
+# python-chzzk
+An unofficial Python library for CHZZK. **Caution**: APIs are currently experimental.
+
+## Requirements
+- Python 3.8+
+
+## Installation
+```python
+pip install chzzk
+```
+
+## Usage
+```python
+import asyncio
+
+from chzzk import Chzzk, Credential
+
+
+async def main():
+    credential = Credential(
+        nid_auth="Your NID_AUT",
+        nid_session="Your NID_SES",
+    )
+    chzzk = Chzzk(credential)
+
+    print(await chzzk.channel("bdc57cc4217173f0e89f63fba2f1c6e5"))
+    print(await chzzk.video(1794))
+
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+## Acknowledgement
+- Thanks [kimcore/chzzk](https://github.com/kimcore/chzzk) for sharing API urls and explaining how it works.

chzzk/__init__.py

@@ -0,0 +1,4 @@
+from chzzk.chzzk import Chzzk
+from chzzk.client import Credential
+
+__version__ = "0.0.2"

chzzk/chzzk.py

@@ -0,0 +1,31 @@
+from typing import Optional
+
+from chzzk.client import ChzzkClient, Credential, GameClient
+from chzzk.models import Channel, User, Video
+from chzzk.models import raw as r
+
+
+class Chzzk:
+    def __init__(self, credential: Optional[Credential] = None):
+        self._client = ChzzkClient(credential)
+        self._game = Game(credential)
+
+    async def me(self) -> User:
+        return await self._game.me()
+
+    async def channel(self, id: str) -> Channel:
+        response = await self._client.get(f"service/v1/channels/{id}")
+        return r.Channel(**response).wrap()
+
+    async def video(self, no: int) -> Video:
+        response = await self._client.get(f"service/v1/videos/{no}")
+        return r.Video(**response).wrap()
+
+
+class Game:
+    def __init__(self, credential: Optional[Credential] = None):
+        self._client = GameClient(credential)
+
+    async def me(self) -> User:
+        response = await self._client.get("v1/user/getUserStatus")
+        return r.User(**response).wrap()

chzzk/client.py

@@ -0,0 +1,92 @@
+from dataclasses import dataclass
+from typing import Any, ClassVar, Mapping, Optional
+from urllib.parse import urljoin
+
+import httpx
+
+from chzzk.errors import ChzzkHTTPError
+
+
+@dataclass
+class Credential:
+    nid_auth: str
+    nid_session: str
+
+    def as_cookie(self) -> dict[str, str]:
+        return {
+            "NID_AUT": self.nid_auth,
+            "NID_SES": self.nid_session,
+        }
+
+
+class HTTPClient:
+    BASE_URL: ClassVar[str]
+
+    def __init__(self, credential: Optional[Credential] = None):
+        assert self.BASE_URL.endswith("/")
+
+        self._credential = credential
+        self._client = httpx.AsyncClient()
+
+        if self._credential is not None:
+            self._client.cookies.update(self._credential.as_cookie())
+
+    async def request(
+        self,
+        method: str,
+        url: str,
+        *,
+        params: Optional[Mapping[str, Any]] = None,
+        data: Optional[Mapping[str, Any]] = None,
+        **kwargs,
+    ) -> Any:
+        raw_response = await self._client.request(
+            method=method,
+            url=urljoin(self.BASE_URL, url),
+            params=params,
+            data=data,
+            **kwargs,
+        )
+
+        if raw_response.status_code != 200:
+            raise ChzzkHTTPError(message="Server did not return a successful response", code=raw_response.status_code)
+
+        response = raw_response.json()
+        if response["code"] != 200:
+            raise ChzzkHTTPError(message=response["message"], code=response["code"])
+
+        return response["content"]
+
+    async def get(
+        self,
+        url: str,
+        *,
+        params: Optional[Mapping[str, Any]] = None,
+        data: Optional[Mapping[str, Any]] = None,
+        **kwargs,
+    ) -> Any:
+        return await self.request("GET", url, params=params, data=data, **kwargs)
+
+    async def post(
+        self,
+        url: str,
+        *,
+        params: Optional[Mapping[str, Any]] = None,
+        data: Optional[Mapping[str, Any]] = None,
+        **kwargs,
+    ) -> Any:
+        return await self.request("POST", url, params=params, data=data, **kwargs)
+
+
+class GameClient(HTTPClient):
+    BASE_URL = "https://comm-api.game.naver.com/nng_main/"
+
+    def __init__(self, credential: Optional[Credential] = None):
+        super().__init__(credential)
+
+
+class ChzzkClient(HTTPClient):
+    BASE_URL = "https://api.chzzk.naver.com/"
+
+    def __init__(self, credential: Optional[Credential] = None):
+        super().__init__(credential)