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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
Status
¶
Bases: Enum
Source code in toggl_api/models/models.py
223 224 225 226 227 228 |
|
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 |
|
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 |
|
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 |
|
running() -> bool
¶
Is this tracker running?
Source code in toggl_api/models/models.py
329 330 331 |
|
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 |
|
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 |
|
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 |
|