Refactoring of caldav_recurring_task

README.md

@@ -1,29 +1,30 @@
-# Dorfsvald PIM
+# CalDav Recurring Tasks Generator
 
-## Téléphone:
+This script is made to be ran once a day. It will create CalDav tasks as described in file tasks.yml. The tasks are created 2 days ahead of their tasks
 
-### Syncevolution
+## Configuration
 
-'''
-sudo -u radicale /usr/bin/syncevo-http-server http://127.0.0.1:9000/syncml --start-dbus-session --debug
-'''
+Update configuration.yml file with caldav server url, calendar name, username and password 
 
-### Filtres
+Describe recurring tasks in tasks.yml file
 
-Event:
-- Enlever event passés d'un mois
+    task_name:
+      start:
+        freq: MONTHLY 
+        bymonthday: -5
+      duration:
+        days: 5
+      title: A title for the task
+      body: A body for the task
+      priority: 1
+
+See https://dateutil.readthedocs.io/en/stable/rrule.html for more information on the start section syntax
+## Usage
+
+    ./main.py
+
+## TODO
 
 Task:
-- Enlever tasks terminée
-- ?
-
-Journal:
-- Ajouter une ligne 5871-DTSTART;VALUE=DATE:20161205
-
-Contacts:
-- Enelver contacts sans tel / email
-- Simplifier les contacts
-
-
-### Requirements
-caldav pyyaml ipdb icalendar
+- Remove completed tasks on new occurence creation
+- Allow the script to run several times on the same day