chore: Configure coverage.io and update ci.yaml (#20)

- Added coverage.io configuration to the project
- Updated ci.yaml to include coverage reporting
- Added coverage badge to README for visual representation of test
coverage

.github/workflows/ci.yml

@@ -37,7 +37,7 @@ jobs:
           poetry run ruff format --check
           poetry build
       - name: Run tests
-        run: poetry run pytest
+        run: poetry run pytest --cov --cov-report=xml
         env:
           COZE_TOKEN: ${{ secrets.COZE_TOKEN }}
           SPACE_ID_1: ${{ secrets.SPACE_ID_1 }}
@@ -47,6 +47,8 @@ jobs:
           COZE_BOT_ID_TRANSLATE: ${{ secrets.COZE_BOT_ID_TRANSLATE }}
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v3
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
 
   test_success:
     # this aggregates success state of all jobs listed in `needs`

CONTRIBUTING.md

@@ -24,8 +24,6 @@ And then install dependencies:
 poetry install
 ```
 
- Run the code
-
 ## Pre Commit
 
 ```shell

README.md

@@ -1,6 +1,7 @@
 # Coze Python API SDK
 
 [![PyPI version](https://img.shields.io/pypi/v/cozepy.svg)](https://pypi.org/project/cozepy/)
+[![codecov](https://codecov.io/github/coze-dev/coze-py/graph/badge.svg?token=U6OKGQXF0E)](https://codecov.io/github/coze-dev/coze-py)
 
 ## Requirements
 
@@ -14,6 +15,10 @@ pip install cozepy
 
 ## Usage
 
+### Examples
+
+TODO
+
 ### Auth
 
 #### Personal Auth Token
@@ -60,7 +65,7 @@ chat = coze.chat.create(
 )
 start = int(time.time())
 while chat.status == ChatStatus.in_progress:
-    if int(time.time()) > 120:
+    if int(time.time()) - start > 120:
         # too long, cancel chat
         coze.chat.cancel(conversation_id=chat.conversation_id, chat_id=chat.chat_id)
         break
@@ -83,7 +88,7 @@ chat_iterator = coze.chat.stream(
 )
 for event in chat_iterator:
     if event.event == ChatEventType.conversation_message_delta:
-        print('got message delta:', event.messages.content)
+        print('got message delta:', event.message.content)
 ```
 
 ### Bots

codecov.yml

@@ -0,0 +1,14 @@
+coverage:
+  status:
+    project: #add everything under here, more options at https://docs.codecov.com/docs/commit-status
+      default:
+        target: 70%
+        threshold: 70%
+        base: auto
+comment:                  #this is a top-level key
+  layout: "diff, flags, files"
+  behavior: default
+  require_changes: true  # if true: only post the comment if coverage changes
+  require_base: true     # if true: must have a base report to post
+  require_head: true     # if true: must have a head report to post
+  hide_project_coverage: false # [true :: only show coverage on the git diff aka patch coverage]]

cozepy/auth/__init__.py

@@ -134,6 +134,7 @@ class TokenAuth(Auth):
     """
 
     def __init__(self, token: str):
+        # TODO: 其他 sdk 实现
         assert isinstance(token, str)
         assert len(token) > 0
         self._token = token

cozepy/chat/__init__.py

@@ -1,4 +1,3 @@
-import json
 from enum import Enum
 from typing import Dict, List, Iterator, Union, TYPE_CHECKING, Optional
 
@@ -184,6 +183,9 @@ class Chat(CozeModel):
     # Details of the information needed for execution.
 
 
+# TODO: 枚举值是否需要大写
+
+
 class ChatEventType(str, Enum):
     # Event for creating a conversation, indicating the start of the conversation.
     # 创建对话的事件，表示对话开始。
@@ -268,17 +270,15 @@ def __next__(self) -> ChatEvent:
             ChatEventType.conversation_message_delta,
             ChatEventType.conversation_message_completed,
         ]:
-            return ChatEvent(
-                event=event, message=Message.model_validate(json.loads(data))
-            )
+            return ChatEvent(event=event, message=Message.model_validate_json(data))
         elif event in [
             ChatEventType.conversation_chat_created,
             ChatEventType.conversation_chat_in_progress,
             ChatEventType.conversation_chat_completed,
             ChatEventType.conversation_chat_failed,
             ChatEventType.conversation_chat_requires_action,
         ]:
-            return ChatEvent(event=event, chat=Chat.model_validate(json.loads(data)))
+            return ChatEvent(event=event, chat=Chat.model_validate_json(data))
         else:
             raise ValueError(f"invalid chat.event: {event}, {data}")
 

pyproject.toml

@@ -14,6 +14,7 @@ typing-extensions = "^4.3.0"
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^7.0.0"
+pytest-cov = "^4.0.0"
 ruff = "^0.6.0"
 pre-commit = "^2.9.0"