Minor changes after pre release review (#71)

* Update dependencies in CI and pre-commit
* Improve type annotations for List fields
* Change irrelevant schema field types
* Add imports to package __init__ to ease module importing

.github/workflows/pr.yml

@@ -15,7 +15,7 @@ concurrency:
 env:
   PYTHON_VERSION: "3.8"
   POETRY_VERSION: "1.8.3"
-  RUFF_VERSION: "0.5.4"
+  RUFF_VERSION: "0.6.7"
 
 jobs:
   lint:

.pre-commit-config.yaml

@@ -13,13 +13,13 @@ repos:
       - id: trailing-whitespace
       - id: mixed-line-ending
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.5.4
+    rev: v0.6.7
     hooks:
       - id: ruff
         args: [ --fix ]
   # Spell Checker
   -   repo: https://github.com/crate-ci/typos
-      rev: v1.23.3
+      rev: v1.24.6
       hooks:
       -   id: typos
   # Git commit linter
@@ -29,7 +29,7 @@ repos:
       -   id: gitlint
   # Detect hardcoded secrets
   -   repo: https://github.com/zricethezav/gitleaks
-      rev: v8.18.4
+      rev: v8.19.2
       hooks:
         - id: gitleaks
   - repo: local
@@ -41,8 +41,3 @@ repos:
         stages: [pre-push]
         language: python
         types: [python]
-
-ci:
-    skip: [test, gitlint]
-    autofix_prs: false
-    autoupdate_schedule: monthly

tests/conftest.py

@@ -16,33 +16,33 @@
 fake = Faker()
 
 
-@pytest.fixture()
+@pytest.fixture
 def response_mock() -> Generator[MockRouter, None, None]:
     with respx_mock(base_url=ROOT_URL) as mock_with_base_url:
         yield mock_with_base_url
 
 
-@pytest.fixture()
+@pytest.fixture
 def response_report_mock() -> Generator[MockRouter, None, None]:
     with respx_mock(base_url=REPORT_ROOT_URL) as mock_with_base_url:
         yield mock_with_base_url
 
 
-@pytest.fixture()
+@pytest.fixture
 def authed_current_user() -> CurrentUser:
     auth = TokenAuth(token=FAKE_TOKEN)
 
     return CurrentUser(auth=auth)
 
 
-@pytest.fixture()
+@pytest.fixture
 def authed_workspace() -> Workspace:
     auth = TokenAuth(token=FAKE_TOKEN)
 
     return Workspace(auth=auth)
 
 
-@pytest.fixture()
+@pytest.fixture
 def authed_report_time_entry() -> ReportTimeEntry:
     auth = TokenAuth(token=FAKE_TOKEN)
 

tests/integration/conftest.py

@@ -39,12 +39,12 @@ def i_authed_report_time_entry() -> ReportTimeEntry:
     return ReportTimeEntry(auth=auth)
 
 
-@pytest.fixture()
+@pytest.fixture
 def me_response(i_authed_user: CurrentUser) -> MeResponse:
     return i_authed_user.me()
 
 
-@pytest.fixture()
+@pytest.fixture
 def me_preferences_response(i_authed_user: CurrentUser) -> MePreferencesResponse:
     return i_authed_user.preferences()
 

toggl_python/__init__.py

@@ -0,0 +1,35 @@
+__version__ = "0.3.0"
+
+from .auth import BasicAuth, TokenAuth
+from .entities.report_time_entry import ReportTimeEntry
+from .entities.user import CurrentUser
+from .entities.workspace import Workspace
+from .exceptions import BadRequest, TogglException
+from .schemas.current_user import MeResponse
+from .schemas.project import ProjectQueryParams, ProjectResponse
+from .schemas.report_time_entry import (
+    SearchReportTimeEntriesRequest,
+    SearchReportTimeEntriesResponse,
+)
+from .schemas.time_entry import MeTimeEntryResponse, TimeEntryCreateRequest, TimeEntryRequest
+from .schemas.workspace import WorkspaceResponse
+
+
+__all__ = (
+    "BasicAuth",
+    "TokenAuth",
+    "CurrentUser",
+    "Workspace",
+    "ReportTimeEntry",
+    "SearchReportTimeEntriesResponse",
+    "SearchReportTimeEntriesRequest",
+    "WorkspaceResponse",
+    "ProjectResponse",
+    "ProjectQueryParams",
+    "MeTimeEntryResponse",
+    "TimeEntryRequest",
+    "TimeEntryCreateRequest",
+    "MeResponse",
+    "BadRequest",
+    "TogglException",
+)

toggl_python/schemas/current_user.py

@@ -22,6 +22,11 @@
 from pydantic.fields import Field
 from pydantic_core import Url
 
+# Move application import `toggl_python.schemas.project.ProjectResponse` into a type-checking block
+from toggl_python.schemas.project import ProjectResponse  # noqa: TCH001
+from toggl_python.schemas.time_entry import MeTimeEntryResponse  # noqa: TCH001
+from toggl_python.schemas.workspace import WorkspaceResponse  # noqa: TCH001
+
 
 class DateFormat(str, Enum):
     mdy_slash = "MM/DD/YYYY"
@@ -99,10 +104,10 @@ class UpdateMeResponse(MeResponseBase):
 
 class MeResponseWithRelatedData(MeResponse):
     clients: Optional[List] = None
-    projects: Optional[List] = None
+    projects: Optional[List[ProjectResponse]] = None
     tags: Optional[List] = None
-    time_entries: Optional[List] = None
-    workspaces: List  # Default workspace is created after signup,
+    time_entries: Optional[List[MeTimeEntryResponse]] = None
+    workspaces: List[WorkspaceResponse]  # Default workspace is created after signup,
 
 
 class UpdateMePasswordRequest(BaseSchema):

toggl_python/schemas/project.py

@@ -8,11 +8,11 @@
 
 class ProjectResponse(BaseSchema):
     active: bool
-    actual_hours: int
-    actual_seconds: int
+    actual_hours: Optional[int]
+    actual_seconds: Optional[int]
     at: datetime
     auto_estimates: Optional[bool]
-    billable: bool
+    billable: Optional[bool]
     can_track_time: bool
     client_id: Optional[int]
     color: str
@@ -32,7 +32,7 @@ class ProjectResponse(BaseSchema):
     recurring_parameters: Optional[List]
     server_deleted_at: Optional[datetime]
     start_date: datetime
-    status: str
+    status: Optional[str] = None
     template: Optional[bool]
     template_id: Optional[int]
     workspace_id: int

toggl_python/schemas/time_entry.py

@@ -14,6 +14,7 @@
 from typing_extensions import Self
 
 from toggl_python.schemas.base import BaseSchema, SinceParamSchemaMixin
+from toggl_python.schemas.project import ProjectResponse  # noqa: TCH001
 
 
 class BulkEditTimeEntriesOperations(str, Enum):
@@ -107,7 +108,7 @@ class WebTimerTimeEntryResponse(MeTimeEntryResponseBase):
 
 class MeWebTimerResponse(BaseSchema):
     clients: Optional[List]
-    projects: Optional[List]
+    projects: Optional[List[ProjectResponse]]
     tags: List
     time_entries: List[WebTimerTimeEntryResponse]