From c5caa109cd5700eeb1949b8328bffcf9d7becc23 Mon Sep 17 00:00:00 2001 From: Mhrooz Date: Fri, 23 Aug 2024 23:47:24 +0200 Subject: [PATCH] add vikunja.py --- inkycal/modules/inkycal_vikunja.py | 207 +++++++++++++++++++++++++++++ 1 file changed, 207 insertions(+) create mode 100644 inkycal/modules/inkycal_vikunja.py diff --git a/inkycal/modules/inkycal_vikunja.py b/inkycal/modules/inkycal_vikunja.py new file mode 100644 index 0000000..3377cab --- /dev/null +++ b/inkycal/modules/inkycal_vikunja.py @@ -0,0 +1,207 @@ +""" +Inkycal Todoist Module +Copyright by aceinnolab +""" +import arrow + +from inkycal.modules.template import inkycal_module +from inkycal.custom import * + +from todoist_api_python.api import TodoistAPI + +logger = logging.getLogger(__name__) + + +class Todoist(inkycal_module): + """Todoist api class + parses todos from the todoist api. + """ + + name = "Vikunja API - show your todos from Vikunja" + + requires = { + 'api_key': { + "label": "Please enter your Todoist API-key", + }, + 'url-frontend': { + "label": "Please enter your Vikunja URL", + }, + 'url-backend': { + "label": "Please enter your Vikunja URL", + }, + } + + optional = { + 'project_filter': { + "label": "Show Todos only from following project (separated by a comma). Leave empty to show " + + "todos from all projects", + } + } + + def __init__(self, config): + """Initialize inkycal_rss module""" + + super().__init__(config) + + config = config['config'] + + # Check if all required parameters are present + for param in self.requires: + if param not in config: + raise Exception(f'config is missing {param}') + + # module specific parameters + self.api_key = config['api_key'] + self.frontend_url = config['url-frontend'] + self.backend_url = config['url-backend'] + + # if project filter is set, initialize it + if config['project_filter'] and isinstance(config['project_filter'], str): + self.project_filter = config['project_filter'].split(',') + else: + self.project_filter = config['project_filter'] + + self._api = TodoistAPI(config['api_key']) + + # give an OK message + logger.debug(f'{__name__} loaded') + + def _validate(self): + """Validate module-specific parameters""" + if not isinstance(self.api_key, str): + print('api_key has to be a string: "Yourtopsecretkey123" ') + + def generate_image(self): + """Generate image for this module""" + + # Define new image size with respect to padding + im_width = int(self.width - (2 * self.padding_left)) + im_height = int(self.height - (2 * self.padding_top)) + im_size = im_width, im_height + logger.debug(f'Image size: {im_size}') + + # Create an image for black pixels and one for coloured pixels + im_black = Image.new('RGB', size=im_size, color='white') + im_colour = Image.new('RGB', size=im_size, color='white') + + # Check if internet is available + if internet_available(): + logger.info('Connection test passed') + else: + logger.error("Network not reachable. Please check your connection.") + raise NetworkNotReachableError + + # Set some parameters for formatting todos + line_spacing = 1 + text_bbox_height = self.font.getbbox("hg") + line_height = text_bbox_height[3] + line_spacing + line_width = im_width + max_lines = im_height // line_height + + # Calculate padding from top so the lines look centralised + spacing_top = int(im_height % line_height / 2) + + # Calculate line_positions + line_positions = [ + (0, spacing_top + _ * line_height) for _ in range(max_lines)] + + # Get all projects by name and id + all_projects = self._api.get_projects() + filtered_project_ids_and_names = {project.id: project.name for project in all_projects} + all_active_tasks = self._api.get_tasks() + + logger.debug(f"all_projects: {all_projects}") + + # Filter entries in all_projects if filter was given + if self.project_filter: + filtered_projects = [project for project in all_projects if project.name in self.project_filter] + filtered_project_ids_and_names = {project.id: project.name for project in filtered_projects} + filtered_project_ids = [project for project in filtered_project_ids_and_names] + logger.debug(f"filtered projects: {filtered_projects}") + + # If filter was activated and no project was found with that name, + # raise an exception to avoid showing a blank image + if not filtered_projects: + logger.error('No project found from project filter!') + logger.error('Please double check spellings in project_filter') + raise Exception('No matching project found in filter. Please ' + 'double check spellings in project_filter or leave' + 'empty') + # filtered version of all active tasks + all_active_tasks = [task for task in all_active_tasks if task.project_id in filtered_project_ids] + + # Simplify the tasks for faster processing + simplified = [ + { + 'name': task.content, + 'due': arrow.get(task.due.date, "YYYY-MM-DD").format("D-MMM-YY") if task.due else "", + 'priority': task.priority, + 'project': filtered_project_ids_and_names[task.project_id] + } + for task in all_active_tasks + ] + + logger.debug(f'simplified: {simplified}') + + project_lengths = [] + due_lengths = [] + + for task in simplified: + if task["project"]: + project_lengths.append(int(self.font.getlength(task['project']) * 1.1)) + if task["due"]: + due_lengths.append(int(self.font.getlength(task['due']) * 1.1)) + + # Get maximum width of project names for selected font + project_offset = int(max(project_lengths)) if project_lengths else 0 + + # Get maximum width of project dues for selected font + due_offset = int(max(due_lengths)) if due_lengths else 0 + + # create a dict with names of filtered groups + groups = {group_name:[] for group_name in filtered_project_ids_and_names.values()} + for task in simplified: + group_of_current_task = task["project"] + if group_of_current_task in groups: + groups[group_of_current_task].append(task) + + logger.debug(f"grouped: {groups}") + + # Add the parsed todos on the image + cursor = 0 + for name, todos in groups.items(): + if todos: + for todo in todos: + if cursor < max_lines: + line_x, line_y = line_positions[cursor] + + if todo['project']: + # Add todos project name + write( + im_colour, line_positions[cursor], + (project_offset, line_height), + todo['project'], font=self.font, alignment='left') + + # Add todos due if not empty + if todo['due']: + write( + im_black, + (line_x + project_offset, line_y), + (due_offset, line_height), + todo['due'], font=self.font, alignment='left') + + if todo['name']: + # Add todos name + write( + im_black, + (line_x + project_offset + due_offset, line_y), + (im_width - project_offset - due_offset, line_height), + todo['name'], font=self.font, alignment='left') + + cursor += 1 + else: + logger.error('More todos than available lines') + break + + # return the images ready for the display + return im_black, im_colour