Добавил строки документации

This commit is contained in:
2025-05-26 13:16:24 +03:00
parent 405576d8cc
commit bb57e3828b
3 changed files with 24 additions and 6 deletions

View File

@@ -21,10 +21,11 @@ class ClockifyAPI(ClockifyConfig):
def get_activities(self, **kwargs) -> list[Activity]:
"""
start: datetime - Начальная дата (обязательно)
end: datetime - Конечная дата (обязательно)
page: int - Номер страницы
page-size: int - Размер страницы (по умолчанию 50)
Получает с сервера Clockify активности за определнный период
start: datetime - Начальная дата (обязательно)
end: datetime - Конечная дата (обязательно)
page: int - Номер страницы
page-size: int - Размер страницы (по умолчанию 50)
"""
time_entries_url = self.time_entries_url
activities = requests.get(self.base_url + time_entries_url, params=kwargs, headers={"X-API-KEY": self.token}).json()
@@ -67,8 +68,9 @@ class ClockifyAPI(ClockifyConfig):
def get_tags(self, **kwargs) -> list[Tag]:
"""
name: str - optional
archived: bool - optional
Получает с сервера Clockify теги
name: str - optional
archived: bool - optional
"""
tags = requests.get(self.base_url + self.tags_url, params=kwargs, headers={"X-API-KEY": self.token}).json()
return [Tag(
@@ -77,6 +79,9 @@ class ClockifyAPI(ClockifyConfig):
) for tag in tags]
def get_vetro_projects(self) -> list[VetroProject]:
"""
Получает с сервера Clockify Проекты (ДО) Ветро
"""
projects = requests.get(self.base_url + self.projects_url, headers={"X-API-KEY": self.token}).json()
for project in projects:
if not project.get("archived"):
@@ -87,6 +92,9 @@ class ClockifyAPI(ClockifyConfig):
) for vetro_project in vetro_projects]
def mark_tracked(self, activities: list[Activity]):
"""
Помечает активности затреканными (Billable) на сервере Clockify
"""
for activity in activities:
try:
resp = requests.put(
@@ -115,6 +123,7 @@ class ClockifyAPI(ClockifyConfig):
return
def _check_token(self, token: str) -> str:
"""Проверяет токен"""
resp = requests.get(self.base_url + self.user_url, headers={"X-API-KEY": token})
if not resp.ok:
logger.error(resp.json())
@@ -124,6 +133,7 @@ class ClockifyAPI(ClockifyConfig):
return token
def getenvs(self):
"""Получает нужные USER_ID и WORKSPACE_ID с сервера Clockify"""
resp = requests.get(self.base_url + self.user_url, headers={"X-API-KEY": self.token})
if not resp.ok:
logger.error(resp.json())