Skip to content

Models

Abstract Classes

toggl_api.models.TogglClass dataclass

Bases: ABC

Base class for all Toggl dataclasses.

Parameters:

  • id (int) –

    Toggl API / Database ID (Primary Key) of the Toggl model.

  • name (str) –

    Name or description of the Toggl project.

  • timestamp (datetime, default: partial(now, tz=utc)() ) –

    Local timestamp of when the Toggl project was last modified.

Source code in toggl_api/models/models.py
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
@dataclass
class TogglClass(ABC):
    """Base class for all Toggl dataclasses.

    Params:
        id: Toggl API / Database ID (Primary Key) of the Toggl model.
        name: Name or description of the Toggl project.
        timestamp: Local timestamp of when the Toggl project was last modified.
    """

    __tablename__ = "base"
    id: int
    name: str
    timestamp: datetime = field(
        compare=False,
        repr=False,
        default_factory=partial(
            datetime.now,
            tz=timezone.utc,
        ),
    )

    def __post_init__(self) -> None:
        if isinstance(self.timestamp, str):
            self.timestamp = parse_iso(self.timestamp)
        elif self.timestamp is None:
            self.timestamp = datetime.now(tz=timezone.utc)

        self.timestamp = self.timestamp.replace(tzinfo=timezone.utc)

    @classmethod
    @abstractmethod
    def from_kwargs(cls, **kwargs: Any) -> TogglClass:
        """Converts an arbitrary amount of kwargs to a model."""
        return cls(
            id=kwargs["id"],
            name=kwargs["name"],
            timestamp=kwargs.get("timestamp") or datetime.now(tz=timezone.utc),
        )

    def __getitem__(self, item: str) -> Any:
        return getattr(self, item)

    def __setitem__(self, item: str, value: Any) -> None:
        setattr(self, item, value)

from_kwargs(**kwargs: Any) -> TogglClass abstractmethod classmethod

Converts an arbitrary amount of kwargs to a model.

Source code in toggl_api/models/models.py
51
52
53
54
55
56
57
58
59
@classmethod
@abstractmethod
def from_kwargs(cls, **kwargs: Any) -> TogglClass:
    """Converts an arbitrary amount of kwargs to a model."""
    return cls(
        id=kwargs["id"],
        name=kwargs["name"],
        timestamp=kwargs.get("timestamp") or datetime.now(tz=timezone.utc),
    )

toggl_api.models.WorkspaceChild dataclass

Bases: TogglClass

Base class for all Toggl workspace objects.

Parameters:

  • id (int) –

    Toggl API / Database ID (Primary Key) of the Toggl object.

  • name (str) –

    Name of the object.

  • timestamp (datetime, default: partial(now, tz=utc)() ) –

    Local timestamp of when the Toggl object was last modified.

  • workspace (int, default: 0 ) –

    The workspace id the Toggl object belongs to.

Source code in toggl_api/models/models.py
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
@dataclass
class WorkspaceChild(TogglClass):
    """Base class for all Toggl workspace objects.

    Params:
        id: Toggl API / Database ID (Primary Key) of the Toggl object.
        name: Name of the object.
        timestamp: Local timestamp of when the Toggl object was last modified.
        workspace: The workspace id the Toggl object belongs to.
    """

    __tablename__ = "workspace_child"

    workspace: int = field(default=0)
    """The id of the workspace that the model belongs to."""

    def __post_init__(self) -> None:
        super().__post_init__()

    @classmethod
    def from_kwargs(cls, **kwargs: Any) -> WorkspaceChild:
        return cls(
            id=kwargs["id"],
            name=kwargs["name"],
            workspace=get_workspace(kwargs),
            timestamp=kwargs.get("timestamp") or datetime.now(tz=timezone.utc),
        )

workspace: int = field(default=0) class-attribute instance-attribute

The id of the workspace that the model belongs to.


Main Models

toggl_api.TogglOrganization dataclass

Bases: TogglClass

Data structure for Toggl organizations.

Parameters:

  • id (int) –

    Toggl API / Database ID (Primary Key) of the Toggl organization.

  • name (str) –

    Name of the Toggl organization. Max 140 characters and min 1 character.

  • timestamp (datetime, default: partial(now, tz=utc)() ) –

    Local timestamp of when the Toggl organization was last modified.

Source code in toggl_api/models/models.py
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
@dataclass
class TogglOrganization(TogglClass):
    """Data structure for Toggl organizations.

    Params:
        id: Toggl API / Database ID (Primary Key) of the Toggl organization.
        name: Name of the Toggl organization. Max 140 characters and min 1 character.
        timestamp: Local timestamp of when the Toggl organization was last modified.
    """

    ___tablename__ = "organization"

    def __post_init__(self) -> None:
        self.validate_name(self.name)
        super().__post_init__()

    @classmethod
    def from_kwargs(cls, **kwargs: Any) -> TogglOrganization:
        """Converts an arbitrary amount of kwargs to an organization."""
        return super().from_kwargs(**kwargs)  # type: ignore[return-value]

    @staticmethod
    def validate_name(name: str, *, max_len: int = 140) -> None:
        """Checks if a organization name is valid for the API."""
        if not name:
            msg = "The organization name need at least have one letter!"
            raise NamingError(msg)
        if max_len and len(name) > max_len:
            msg = f"Max organization name length is {max_len}!"
            raise NamingError(msg)

validate_name(name: str, *, max_len: int = 140) -> None staticmethod

Checks if a organization name is valid for the API.

Source code in toggl_api/models/models.py
89
90
91
92
93
94
95
96
97
@staticmethod
def validate_name(name: str, *, max_len: int = 140) -> None:
    """Checks if a organization name is valid for the API."""
    if not name:
        msg = "The organization name need at least have one letter!"
        raise NamingError(msg)
    if max_len and len(name) > max_len:
        msg = f"Max organization name length is {max_len}!"
        raise NamingError(msg)

from_kwargs(**kwargs: Any) -> TogglOrganization classmethod

Converts an arbitrary amount of kwargs to an organization.

Source code in toggl_api/models/models.py
84
85
86
87
@classmethod
def from_kwargs(cls, **kwargs: Any) -> TogglOrganization:
    """Converts an arbitrary amount of kwargs to an organization."""
    return super().from_kwargs(**kwargs)  # type: ignore[return-value]

toggl_api.TogglWorkspace dataclass

Bases: TogglClass

Data structure for Toggl workspaces.

Parameters:

  • id (int) –

    Toggl API / Database ID (Primary Key) of the Toggl workspace.

  • name (str) –

    Name of the workspace.

  • timestamp (datetime, default: partial(now, tz=utc)() ) –

    Local timestamp of when the Toggl workspace was last modified.

  • organization (int, default: 0 ) –

    Organization id the workspace belongs to.

Source code in toggl_api/models/models.py
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
@dataclass
class TogglWorkspace(TogglClass):
    """Data structure for Toggl workspaces.

    Params:
        id: Toggl API / Database ID (Primary Key) of the Toggl workspace.
        name: Name of the workspace.
        timestamp: Local timestamp of when the Toggl workspace was last modified.
        organization: Organization id the workspace belongs to.
    """

    ___tablename__ = "workspace"

    organization: int = field(default=0)

    def __post_init__(self) -> None:
        super().__post_init__()
        try:
            TogglWorkspace.validate_name(self.name)
        except NamingError as err:
            if str(err) != "No spaces allowed in the workspace name!":
                raise
            log.warning(err)
            self.name = self.name.replace(" ", "-")
            log.warning("Updated to new name: %s!", self.name)

    @classmethod
    def from_kwargs(cls, **kwargs: Any) -> TogglWorkspace:
        """Converts an arbitrary amount of kwargs to a workspace."""
        return cls(
            id=kwargs["id"],
            name=kwargs["name"],
            timestamp=kwargs.get("timestamp") or datetime.now(tz=timezone.utc),
            organization=kwargs.get("organization", 0),
        )

    @staticmethod
    def validate_name(name: str, *, max_len: int = 140) -> None:
        """Checks if a workspace name is valid for the API."""
        if not name:
            msg = "The workspace name need at least have one character!"
            raise NamingError(msg)
        if max_len and len(name) > max_len:
            msg = f"The max workspace name length is {max_len}!"
            raise NamingError(msg)
        if " " in name:
            msg = "No spaces allowed in the workspace name!"
            raise NamingError(msg)

validate_name(name: str, *, max_len: int = 140) -> None staticmethod

Checks if a workspace name is valid for the API.

Source code in toggl_api/models/models.py
136
137
138
139
140
141
142
143
144
145
146
147
@staticmethod
def validate_name(name: str, *, max_len: int = 140) -> None:
    """Checks if a workspace name is valid for the API."""
    if not name:
        msg = "The workspace name need at least have one character!"
        raise NamingError(msg)
    if max_len and len(name) > max_len:
        msg = f"The max workspace name length is {max_len}!"
        raise NamingError(msg)
    if " " in name:
        msg = "No spaces allowed in the workspace name!"
        raise NamingError(msg)

from_kwargs(**kwargs: Any) -> TogglWorkspace classmethod

Converts an arbitrary amount of kwargs to a workspace.

Source code in toggl_api/models/models.py
126
127
128
129
130
131
132
133
134
@classmethod
def from_kwargs(cls, **kwargs: Any) -> TogglWorkspace:
    """Converts an arbitrary amount of kwargs to a workspace."""
    return cls(
        id=kwargs["id"],
        name=kwargs["name"],
        timestamp=kwargs.get("timestamp") or datetime.now(tz=timezone.utc),
        organization=kwargs.get("organization", 0),
    )

toggl_api.TogglClient dataclass

Bases: WorkspaceChild

Data structure for Toggl clients.

Parameters:

  • id (int) –

    Toggl API / Database ID (Primary Key) of the Toggl client.

  • name (str) –

    Name of the client.

  • timestamp (datetime, default: partial(now, tz=utc)() ) –

    Local timestamp of when the Toggl client was last modified.

  • workspace (int, default: 0 ) –

    The workspace id the Toggl client belongs to.

Source code in toggl_api/models/models.py
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
@dataclass
class TogglClient(WorkspaceChild):
    """Data structure for Toggl clients.

    Params:
        id: Toggl API / Database ID (Primary Key) of the Toggl client.
        name: Name of the client.
        timestamp: Local timestamp of when the Toggl client was last modified.
        workspace: The workspace id the Toggl client belongs to.
    """

    __tablename__ = "client"

    def __post_init__(self) -> None:
        super().__post_init__()

    @classmethod
    def from_kwargs(cls, **kwargs: Any) -> TogglClient:
        """Converts an arbitrary amount of kwargs to a client."""
        return super().from_kwargs(**kwargs)  # type: ignore[return-value]

from_kwargs(**kwargs: Any) -> TogglClient classmethod

Converts an arbitrary amount of kwargs to a client.

Source code in toggl_api/models/models.py
195
196
197
198
@classmethod
def from_kwargs(cls, **kwargs: Any) -> TogglClient:
    """Converts an arbitrary amount of kwargs to a client."""
    return super().from_kwargs(**kwargs)  # type: ignore[return-value]

toggl_api.TogglProject dataclass

Bases: WorkspaceChild

Data structure for Toggl projects.

Attributes:

  • Status

    An enumeration with all project statuses supported by the API.

Parameters:

  • id (int) –

    Toggl API / Database ID (Primary Key) of the Toggl project.

  • name (str) –

    Name of the project.

  • timestamp (datetime, default: partial(now, tz=utc)() ) –

    Local timestamp of when the Toggl project was last modified.

  • workspace (int, default: 0 ) –

    The workspace id the project belongs to.

  • color (str, default: '#0b83d9' ) –

    Color of the project. Defaults to blue. Refer to this endpoint attribute for basic colors.

  • client (Optional[int], default: None ) –

    ID of the client the project belongs to. Defaults to None.

  • active (bool, default: True ) –

    Whether the project is archived or not. Defaults to True.

  • start_date (date, default: lambda: date()() ) –

    When the project is supposed to start. Will default to the original date.

  • end_date (Optional[date], default: None ) –

    When the projects is supposed to end. None if there is no deadline. Optional.

Source code in toggl_api/models/models.py
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
@dataclass
class TogglProject(WorkspaceChild):
    """Data structure for Toggl projects.

    Attributes:
        Status: An enumeration with all project statuses supported by the API.

    Params:
        id: Toggl API / Database ID (Primary Key) of the Toggl project.
        name: Name of the project.
        timestamp: Local timestamp of when the Toggl project was last modified.
        workspace: The workspace id the project belongs to.
        color: Color of the project. Defaults to blue. Refer to this endpoint
            [attribute][toggl_api.ProjectEndpoint.BASIC_COLORS] for basic colors.
        client: ID of the client the project belongs to. Defaults to None.
        active: Whether the project is archived or not. Defaults to True.
        start_date: When the project is supposed to start. Will default to
            the original date.
        end_date: When the projects is supposed to end. None if there is no
            deadline. Optional.
    """

    class Status(enum.Enum):
        UPCOMING = enum.auto()
        ACTIVE = enum.auto()
        ENDED = enum.auto()
        ARCHIVED = enum.auto()
        DELETED = enum.auto()

    __tablename__ = "project"

    color: str = field(default="#0b83d9")
    client: Optional[int] = field(default=None)
    active: bool = field(default=True)

    start_date: date = field(default_factory=lambda: datetime.now(tz=timezone.utc).date())
    end_date: Optional[date] = field(default=None)

    def __post_init__(self) -> None:
        super().__post_init__()
        if isinstance(self.client, TogglClient):
            self.client = self.client.id

        if isinstance(self.start_date, str):
            self.start_date = parse_iso(self.start_date).date()

        if isinstance(self.end_date, str):
            self.stop_date = parse_iso(self.end_date).date()

    @classmethod
    def from_kwargs(cls, **kwargs: Any) -> TogglProject:
        """Converts an arbitrary amount of kwargs to a project."""
        return cls(
            id=kwargs["id"],
            name=kwargs["name"],
            workspace=get_workspace(kwargs),
            color=kwargs["color"],
            client=kwargs.get("client_id") or kwargs.get("client"),
            active=kwargs["active"],
            timestamp=kwargs.get("timestamp") or datetime.now(tz=timezone.utc),
            start_date=kwargs.get("start_date") or datetime.now(tz=timezone.utc).date(),
            end_date=kwargs.get("end_date"),
        )

    def get_status(self) -> TogglProject.Status:
        """Derive the project status from instance attributes."""
        if not self.active:
            return TogglProject.Status.ARCHIVED
        now = datetime.now(timezone.utc)
        if now < self.start_date:
            return TogglProject.Status.UPCOMING
        if self.end_date and now >= self.end_date:
            return TogglProject.Status.ENDED
        return TogglProject.Status.ACTIVE

Status

Bases: Enum

Source code in toggl_api/models/models.py
223
224
225
226
227
228
class Status(enum.Enum):
    UPCOMING = enum.auto()
    ACTIVE = enum.auto()
    ENDED = enum.auto()
    ARCHIVED = enum.auto()
    DELETED = enum.auto()

get_status() -> TogglProject.Status

Derive the project status from instance attributes.

Source code in toggl_api/models/models.py
265
266
267
268
269
270
271
272
273
274
def get_status(self) -> TogglProject.Status:
    """Derive the project status from instance attributes."""
    if not self.active:
        return TogglProject.Status.ARCHIVED
    now = datetime.now(timezone.utc)
    if now < self.start_date:
        return TogglProject.Status.UPCOMING
    if self.end_date and now >= self.end_date:
        return TogglProject.Status.ENDED
    return TogglProject.Status.ACTIVE

from_kwargs(**kwargs: Any) -> TogglProject classmethod

Converts an arbitrary amount of kwargs to a project.

Source code in toggl_api/models/models.py
250
251
252
253
254
255
256
257
258
259
260
261
262
263
@classmethod
def from_kwargs(cls, **kwargs: Any) -> TogglProject:
    """Converts an arbitrary amount of kwargs to a project."""
    return cls(
        id=kwargs["id"],
        name=kwargs["name"],
        workspace=get_workspace(kwargs),
        color=kwargs["color"],
        client=kwargs.get("client_id") or kwargs.get("client"),
        active=kwargs["active"],
        timestamp=kwargs.get("timestamp") or datetime.now(tz=timezone.utc),
        start_date=kwargs.get("start_date") or datetime.now(tz=timezone.utc).date(),
        end_date=kwargs.get("end_date"),
    )

toggl_api.TogglTracker dataclass

Bases: WorkspaceChild

Data structure for trackers.

Parameters:

  • id (int) –

    Toggl API / Database ID (Primary Key) of the Toggl tracker.

  • name (str) –

    Description of the tracker. Refers to tracker description inside the Toggl API.

  • timestamp (datetime, default: partial(now, tz=utc)() ) –

    Local timestamp of when the Toggl tracker was last modified.

  • workspace (int, default: 0 ) –

    The workspace id the tracker belongs to.

  • start (datetime, default: partial(now, tz=utc)() ) –

    Start time of the tracker. Defaults to time created if nothing is passed.

  • duration (Optional[timedelta], default: None ) –

    Duration of the tracker

  • stop (Optional[datetime | str], default: None ) –

    Stop time of the tracker.

  • project (Optional[int], default: None ) –

    Id of the project the tracker is assigned to.

  • tags (list[TogglTag], default: list() ) –

    List of tags.

Methods:

  • running

    Whether the tracker is running.

Source code in toggl_api/models/models.py
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
@dataclass
class TogglTracker(WorkspaceChild):
    """Data structure for trackers.

    Params:
        id: Toggl API / Database ID (Primary Key) of the Toggl tracker.
        name: Description of the tracker. Refers to tracker **description**
            inside the Toggl API.
        timestamp: Local timestamp of when the Toggl tracker was last modified.
        workspace: The workspace id the tracker belongs to.
        start: Start time of the tracker. Defaults to time created if nothing
            is passed.
        duration: Duration of the tracker
        stop: Stop time of the tracker.
        project: Id of the project the tracker is assigned to.
        tags: List of tags.

    Methods:
        running: Whether the tracker is running.
    """

    __tablename__ = "tracker"

    start: datetime = field(
        default_factory=partial(
            datetime.now,
            tz=timezone.utc,
        ),
    )
    duration: Optional[timedelta] = field(default=None)
    stop: Optional[datetime | str] = field(default=None)
    project: Optional[int] = field(default=None)
    tags: list[TogglTag] = field(default_factory=list)

    def __post_init__(self) -> None:
        super().__post_init__()
        if isinstance(self.project, TogglProject):
            self.project = self.project.id
        if isinstance(self.start, str | datetime):
            self.start = parse_iso(self.start)  # type: ignore[assignment]
        if isinstance(self.duration, float | int):
            self.duration = timedelta(seconds=self.duration)

        if self.stop:
            self.stop = parse_iso(self.stop)  # type: ignore[assignment]
        else:
            now = datetime.now(tz=timezone.utc)
            self.duration = now - self.start

        if isinstance(self.stop, str | datetime):
            self.stop = parse_iso(self.stop)  # type: ignore[assignment]

    def running(self) -> bool:
        """Is this tracker running?"""
        return self.stop is None

    @classmethod
    def from_kwargs(cls, **kwargs: Any) -> TogglTracker:
        """Converts an arbitrary amount of kwargs to a tracker."""
        start = kwargs.get("start")
        if start is None:
            start = datetime.now(tz=timezone.utc)
            log.info("No start time provided. Using current time as start time: %s", start)

        return cls(
            id=kwargs["id"],
            name=kwargs.get("description", kwargs.get("name", "")),
            workspace=get_workspace(kwargs),
            start=start,
            duration=kwargs.get("duration"),
            stop=kwargs.get("stop"),
            project=kwargs.get("project_id", kwargs.get("project")),
            tags=TogglTracker.get_tags(**kwargs),
            timestamp=kwargs.get("timestamp", datetime.now(tz=timezone.utc)),
        )

    @staticmethod
    def get_tags(**kwargs: Any) -> list[TogglTag]:
        tag_id = kwargs.get("tag_ids")
        tag = kwargs.get("tags")
        tags = []
        if tag and isinstance(tag[0], dict):
            for t in tag:
                tags.append(TogglTag.from_kwargs(**t))  # noqa: PERF401
        elif tag_id and tag:
            workspace = get_workspace(kwargs)
            for i, t in zip(tag_id, tag, strict=True):
                tags.append(TogglTag(id=i, name=t, workspace=workspace))
        else:
            tags = tag or tags  # type: ignore[assignment]

        return tags

running() -> bool

Is this tracker running?

Source code in toggl_api/models/models.py
329
330
331
def running(self) -> bool:
    """Is this tracker running?"""
    return self.stop is None

from_kwargs(**kwargs: Any) -> TogglTracker classmethod

Converts an arbitrary amount of kwargs to a tracker.

Source code in toggl_api/models/models.py
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
@classmethod
def from_kwargs(cls, **kwargs: Any) -> TogglTracker:
    """Converts an arbitrary amount of kwargs to a tracker."""
    start = kwargs.get("start")
    if start is None:
        start = datetime.now(tz=timezone.utc)
        log.info("No start time provided. Using current time as start time: %s", start)

    return cls(
        id=kwargs["id"],
        name=kwargs.get("description", kwargs.get("name", "")),
        workspace=get_workspace(kwargs),
        start=start,
        duration=kwargs.get("duration"),
        stop=kwargs.get("stop"),
        project=kwargs.get("project_id", kwargs.get("project")),
        tags=TogglTracker.get_tags(**kwargs),
        timestamp=kwargs.get("timestamp", datetime.now(tz=timezone.utc)),
    )

toggl_api.TogglTag dataclass

Bases: WorkspaceChild

Data structure for Toggl tags.

Parameters:

  • id (int) –

    Toggl API / Database ID (Primary Key) of the Toggl tag.

  • name (str) –

    Name of the tag.

  • timestamp (datetime, default: partial(now, tz=utc)() ) –

    Local timestamp of when the Toggl tag was last modified.

  • workspace (int, default: 0 ) –

    The workspace id the tag belongs to.

Source code in toggl_api/models/models.py
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
@dataclass
class TogglTag(WorkspaceChild):
    """Data structure for Toggl tags.

    Params:
        id: Toggl API / Database ID (Primary Key) of the Toggl tag.
        name: Name of the tag.
        timestamp: Local timestamp of when the Toggl tag was last modified.
        workspace: The workspace id the tag belongs to.
    """

    __tablename__ = "tag"

    def __post_init__(self) -> None:
        super().__post_init__()

    @classmethod
    def from_kwargs(cls, **kwargs: Any) -> TogglTag:
        """Converts an arbitrary amount of kwargs to a tag."""
        return super().from_kwargs(**kwargs)  # type: ignore[return-value]

from_kwargs(**kwargs: Any) -> TogglTag classmethod

Converts an arbitrary amount of kwargs to a tag.

Source code in toggl_api/models/models.py
387
388
389
390
@classmethod
def from_kwargs(cls, **kwargs: Any) -> TogglTag:
    """Converts an arbitrary amount of kwargs to a tag."""
    return super().from_kwargs(**kwargs)  # type: ignore[return-value]