icalcli 1.0.4__tar.gz → 1.0.6__tar.gz

{icalcli-1.0.4/icalcli.egg-info → icalcli-1.0.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: icalcli
-Version: 1.0.4
+Version: 1.0.6
 Summary: Icalendar Calendar Command Line Interface
 Home-page: https://github.com/jrvarma/icalcli
 Maintainer: Jayanth R. Varma
@@ -12,8 +12,13 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.6
 Description-Content-Type: text/markdown
-Provides-Extra: parsedatetime
 License-File: LICENSE
+Requires-Dist: python-dateutil
+Requires-Dist: parsedatetime
+Requires-Dist: icalendar
+Requires-Dist: recurring_ical_events
+Provides-Extra: parsedatetime
+Requires-Dist: parsedatetime; extra == "parsedatetime"
 
 # icalcli
 
@@ -66,6 +71,7 @@ python setup.py install
     edit (e)               edit calendar events
     agenda (g)             get an agenda for a time period
     calw (w)               get a week-based agenda in calendar format
+    cal5w (5w)             get this week / 2 past / 2 future weeks agenda in calendar format
     calm (m)               get a month agenda in calendar format
     add (a)                add a detailed event to the calendar
     search (s)             (regex) search for events 
@@ -87,6 +93,15 @@ backend_interface = ICSInterface("/path/to/ics-file")
 
 ```
 
+#### Example configuration for multiple readonly file_backend
+
+```
+from icalcli import ICSInterface
+
+backend_interface = ICSInterface(["/path/to/ics-file-1", "/path/to/ics-file-2"])
+
+```
+
 #### Example configuration for etesync_backend
 
 This configuration assumes that all the credentials are stored in a plain text (`json`) file. In practice, you would use a more secure storage (perhaps, the `Gnome keyring`) or just read it from the terminal.
@@ -106,6 +121,16 @@ backend_interface = EtesyncInterface(
 ```
 See the [Example code](https://github.com/jrvarma/icalcli/issues/1#issuecomment-979851222) for getting the  `uid` and `authToken` for the `etesync` calendar.
 
+## Recurring events and default search period
+
+`icalcli` understands the `RRULE`, `RDATE`, `EXRULE`, `EXDATE` elements of the `icalendar` specification. These elements can be added while creating or editing events using `--rrule`, `--rdate`, `--exrule` and `--exdate` options.
+
+In most views, the instances of the recurring event are displayed. Since a recurring event can have an unlimited number of instances, searches with no start or end date can produce an unending series of events. By default therefore searches with no start or end date are limited to the previous five years and following five years. These defaults can be changed using the options ` --default_past_years` and `--default_future_years`
+
+## Raw ICS
+
+The `icalendar` specification is quite large and complex, and `icalcli` implements only the most common parts of this specification. It is possible to use the `--raw_ics` option to create/edit event using raw ICS text. 
+
 ## Screenshots
 
 Some screenshots are available at Github:

icalcli-1.0.4/PKG-INFO → icalcli-1.0.6/README.md

@@ -1,20 +1,3 @@
-Metadata-Version: 2.1
-Name: icalcli
-Version: 1.0.4
-Summary: Icalendar Calendar Command Line Interface
-Home-page: https://github.com/jrvarma/icalcli
-Maintainer: Jayanth R. Varma
-Maintainer-email: jrvarma@gmail.com
-Classifier: Development Status :: 3 - Alpha
-Classifier: Environment :: Console
-Classifier: Intended Audience :: End Users/Desktop
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Requires-Python: >=3.6
-Description-Content-Type: text/markdown
-Provides-Extra: parsedatetime
-License-File: LICENSE
-
 # icalcli
 
 ### An iCalendar Command Line Interface
@@ -66,6 +49,7 @@ python setup.py install
     edit (e)               edit calendar events
     agenda (g)             get an agenda for a time period
     calw (w)               get a week-based agenda in calendar format
+    cal5w (5w)             get this week / 2 past / 2 future weeks agenda in calendar format
     calm (m)               get a month agenda in calendar format
     add (a)                add a detailed event to the calendar
     search (s)             (regex) search for events 
@@ -87,6 +71,15 @@ backend_interface = ICSInterface("/path/to/ics-file")
 
 ```
 
+#### Example configuration for multiple readonly file_backend
+
+```
+from icalcli import ICSInterface
+
+backend_interface = ICSInterface(["/path/to/ics-file-1", "/path/to/ics-file-2"])
+
+```
+
 #### Example configuration for etesync_backend
 
 This configuration assumes that all the credentials are stored in a plain text (`json`) file. In practice, you would use a more secure storage (perhaps, the `Gnome keyring`) or just read it from the terminal.
@@ -106,6 +99,16 @@ backend_interface = EtesyncInterface(
 ```
 See the [Example code](https://github.com/jrvarma/icalcli/issues/1#issuecomment-979851222) for getting the  `uid` and `authToken` for the `etesync` calendar.
 
+## Recurring events and default search period
+
+`icalcli` understands the `RRULE`, `RDATE`, `EXRULE`, `EXDATE` elements of the `icalendar` specification. These elements can be added while creating or editing events using `--rrule`, `--rdate`, `--exrule` and `--exdate` options.
+
+In most views, the instances of the recurring event are displayed. Since a recurring event can have an unlimited number of instances, searches with no start or end date can produce an unending series of events. By default therefore searches with no start or end date are limited to the previous five years and following five years. These defaults can be changed using the options ` --default_past_years` and `--default_future_years`
+
+## Raw ICS
+
+The `icalendar` specification is quite large and complex, and `icalcli` implements only the most common parts of this specification. It is possible to use the `--raw_ics` option to create/edit event using raw ICS text. 
+
 ## Screenshots
 
 Some screenshots are available at Github:

{icalcli-1.0.4 → icalcli-1.0.6}/icalcli/argparsers.py

@@ -263,6 +263,11 @@ def get_argument_parser(initial=True):
         parents=[outputs_parser, output_parser, cal_query_parser])
     calw.add_argument('-n', "--weeks", type=int, default=2, nargs="?")
 
+    cal5w = sub.add_parser(
+        "cal5w", aliases=['5w'],
+        parents=[outputs_parser, output_parser, cal_query_parser])
+    cal5w.add_argument('-n', "--weeks", type=int, default=2, nargs="?")
+
     sub.add_parser(
         "calm", aliases=['m'],
         parents=[outputs_parser, output_parser, cal_query_parser])

{icalcli-1.0.4 → icalcli-1.0.6}/icalcli/file_backend/ics_interface.py

@@ -12,10 +12,14 @@ class ICSInterface:
         filename : path to ics file
         backup: boolean whether to back up old file before overwriting
         """
-        self.filepath = Path(filename).resolve()
+        if isinstance(filename, list):
+            self.filepaths = [Path(f).resolve() for f in filename]
+            self.readonly = True
+        else:
+            self.filepaths = [Path(filename).resolve()]
+            self.readonly = False
         self.backup = backup
-        with open(self.filepath, 'r') as fp:
-            self.ics = fp.read()
+        self.ics = []
         self.all_events()
 
     def all_events(self):
@@ -26,13 +30,20 @@ class ICSInterface:
                 return False
             else:
                 return True
-        self.calendar = Calendar.from_ical(self.ics)
-        self.events = [ev for ev in self.calendar.walk('VEVENT')
-                       if check_event(ev)]
+        self.events = []
         self.cache_events = {}
-        for ev in self.events:
-            uid = ev.decoded('uid').decode()
-            self.cache_events[uid] = ev
+        filecount = 0
+        for path in self.filepaths:
+            with open(path, 'r') as fp:
+                cal = Calendar.from_ical(fp.read())
+            events = [ev for ev in cal.walk('VEVENT') if check_event(ev)]
+            self.events += events
+            for ev in events:
+                uid = ev.decoded('uid').decode()
+                if len(self.filepaths) > 1:
+                    uid = f"File{filecount}:{uid}"
+                self.cache_events[uid] = ev
+            filecount += 1
 
     def create_event(self, event, vtimezone=None):
         uid = event.decoded('uid').decode()
@@ -46,6 +57,8 @@ class ICSInterface:
         del self.cache_events[uid]
 
     def sync(self, vtimezone=None):
+        if self.readonly:
+            return
         if self.backup:
             with NamedTemporaryFile(mode='w',
                                     suffix=self.filepath.suffix,

{icalcli-1.0.4 → icalcli-1.0.6}/icalcli/icalcli.py

@@ -95,6 +95,7 @@ class IcalendarInterface:
     UNIWIDTH = {'W': 2, 'F': 2, 'N': 1, 'Na': 1, 'H': 1, 'A': 1}
     backend_cache_dirty = False
     default_outputs = ['end', 'alarms', 'freebusy', 'location']
+    default_graphical_outputs = ['end', 'alarms']
     no_past_events = 5
     no_future_events = 10
 
@@ -104,6 +105,7 @@ class IcalendarInterface:
         self.cals = []
         self.printer = printer
         self.initial_options = options
+        self.initial_options['stack_trace'] = True
         self.set_options(options)
         self.add_parser = add_parser
         self.backend_interface = backend_interface
@@ -128,6 +130,10 @@ class IcalendarInterface:
         for key in self.default_outputs:
             if key not in self.outputs:
                 self.outputs[key] = True
+        self.graphical_outputs = options.get('outputs', {})
+        for key in self.default_graphical_outputs:
+            if key not in self.outputs:
+                self.graphical_outputs[key] = True
 
     def set_now(self):
         # This command is run at initiaization, but it should also be
@@ -157,6 +163,12 @@ class IcalendarInterface:
             self.readonly = True
             self.printer.err_msg('Duplicate UIDs found. '
                                  'Calendar deduplicated and set to readonly\n')
+        elif (
+                    hasattr(self.backend_interface, 'readonly')
+                    and self.backend_interface.readonly
+        ):
+            self.readonly = True
+            self.printer.err_msg('Calendar backend interface is readonly\n')
         else:
             self.readonly = False
 
@@ -323,7 +335,7 @@ class IcalendarInterface:
         """
         return e_start < time_point and e_end >= time_point
 
-    def format_title(self, event, allday=False):
+    def event_summary(self, event, allday=False):
         r"""Return event title (summary and start time)
 
         Parameters
@@ -335,19 +347,52 @@ class IcalendarInterface:
         -------
         string
         """
+        def fmt_time(field):
+            if self.options['military']:
+                return self.decode_dtm(event, field).strftime("%H:%M")
+            else:
+                return (
+                    self.decode_dtm(event, field).strftime("%I:%M")
+                    .lstrip('0') +
+                    self.decode_dtm(event, field).strftime('%p') .lower())
         titlestr = self.valid_title(event)
         if allday:
-            return titlestr
-        elif self.options['military']:
-            return ' '.join(
-                [self.decode_dtm(event, 'dtstart').strftime("%H:%M"),
-                 titlestr])
+            summary = titlestr
         else:
-            return ' '.join([
-                self.decode_dtm(event, 'dtstart').strftime("%I:%M")
-                .lstrip('0') +
-                self.decode_dtm(event, 'dtstart').strftime('%p')
-                .lower(), titlestr])
+            tm = fmt_time('dtstart')
+            if self.graphical_outputs.get('end'):
+                tm += " - " + fmt_time('dtend')
+            summary = tm + " " + titlestr
+        if self.graphical_outputs.get('alarms'):
+            alarms = event.walk('valarm')
+            if alarms:
+                if isinstance(alarms[0].Decoded('trigger'), timedelta):
+                    minutes = -(alarms[0].Decoded('trigger')
+                                .total_seconds()/60)
+                    summary += ' AL:%.0fm' % minutes
+                else:
+                    summary += ' AL: ??'
+        if self.graphical_outputs.get('freebusy'):
+            free = ('transp' in event and
+                    event.Decoded('transp').decode() == 'TRANSPARENT')
+            summary += (' free ' if free else ' busy ')
+        if (
+                self.graphical_outputs.get('location')
+                and 'location' in event
+                and event.Decoded('location').decode().strip()
+        ):
+            summary += " [%s]" % (event.Decoded('location').
+                                  decode().strip())
+        if self.graphical_outputs.get('uid'):
+            summary += " <%s>" % (event.Decoded('uid').decode().strip())
+        if (
+                self.graphical_outputs.get('description')
+                and 'description' in event
+                and event.Decoded('description').decode().strip()
+                and self.outputs.get('description')
+        ):
+            summary += event.Decoded('description'). decode().strip()
+        return summary
 
     def get_week_events(self, start_dt, end_dt, event_list):
         r"""Returns all events during a week (start_dt to end_dt)
@@ -401,9 +446,11 @@ class IcalendarInterface:
                 force_now_marker = False
 
                 if to_show_now:
-                    if(self.now >= event_start_date
-                       and self.now <= event_end_date
-                       and not event_allday):
+                    if (
+                            self.now >= event_start_date
+                            and self.now <= event_end_date
+                            and not event_allday
+                    ):
                         # line marker is during event (recolor event)
                         force_now_marker = True
                         to_show_now = False
@@ -429,7 +476,7 @@ class IcalendarInterface:
                     event_color = 'default'
                 # NOTE(slawqo): for all day events it's necessary to
                 # add event to more than one day in week_events
-                titlestr = self.format_title(event, allday=event_allday)
+                summary = self.event_summary(event, allday=event_allday)
                 if event_allday and event_start_date < event_end_date:
                     if event_end_date >= end_dt:
                         end_daynum = 6
@@ -444,12 +491,12 @@ class IcalendarInterface:
                     #     event_daynum = 0
                     for day in range(start_daynum, end_daynum + 1):
                         week_events[day].append(
-                            EventTitle('\n' + titlestr, event_color))
+                            EventTitle('\n' + summary, event_color))
                 else:
                     # newline and empty string are the keys to turn off
                     # coloring
                     week_events[event_daynum].append(
-                            EventTitle('\n' + titlestr, event_color))
+                            EventTitle('\n' + summary, event_color))
         return week_events
 
     def printed_len(self, string):
@@ -504,20 +551,23 @@ class IcalendarInterface:
         -------
         int: where to cut the word
         """
-        print_len = 0
+        # print_len = 0
 
         words = _u(string).split()
         for i, word in enumerate(words):
+            print_len = self.printed_len(' '.join(words[:i]))
             word_len = self.printed_len(word)
-            if ((cur_print_len + word_len + print_len
-                 ) >= self.options['cal_width']):
+            if (
+                    (cur_print_len + word_len + print_len
+                     ) >= self.options['cal_width']
+            ):
                 cut_idx = len(' '.join(words[:i]))
                 # if the  word is too long,
                 # we cannot cut between words
                 if cut_idx == 0:
                     return self.word_cut(word)
                 return (print_len, cut_idx)
-            print_len += word_len + i  # +i for the space between words
+            # print_len += word_len + i  # +i for the space between words
         return (print_len, len(' '.join(words[:i])))
 
     def get_cut_index(self, event_string):
@@ -553,7 +603,7 @@ class IcalendarInterface:
 
         Parameters
         ----------
-        cmd : Command ('calw' or 'calm' for week and month)
+        cmd : Command ('calw', 'cal5w'  or 'calm' for week, 5weeks and month)
         startDateTime : datetime (start date)
         count : int (number of weeks or months)
         eventList : list of icalendar events
@@ -637,7 +687,7 @@ class IcalendarInterface:
         for i in range(count):
             # create and print the date line for a week
             for j in range(days):
-                if cmd == 'calw':
+                if cmd in ('calw', 'cal5w'):
                     d = (startWeekDateTime +
                          timedelta(days=j)).strftime("%d %b")
                 else:  # (cmd == 'calm'):
@@ -648,9 +698,11 @@ class IcalendarInterface:
                         d = ''
                 tmpDateColor = self.options['color_date']
 
-                if (self.now.strftime("%d%b%Y") == (
-                        (startWeekDateTime + timedelta(days=j))
-                        .strftime("%d%b%Y"))):
+                if (
+                        self.now.strftime("%d%b%Y") == (
+                            (startWeekDateTime + timedelta(days=j))
+                            .strftime("%d%b%Y"))
+                ):
                     tmpDateColor = self.options['color_now_marker']
                     d += " **"
 
@@ -690,7 +742,6 @@ class IcalendarInterface:
                         curr_event.title)
                     padding = ' ' * (self.options['cal_width']
                                      - print_len)
-
                     self.printer.msg(
                             curr_event.title[:cut_idx] + padding,
                             curr_event.color)
@@ -834,9 +885,11 @@ class IcalendarInterface:
         self.printer.msg('  %s' % self.valid_title(event).strip(),
                          eventColor)
 
-        if(self.outputs.get('location')
-           and 'location' in event
-           and event.Decoded('location').decode().strip()):
+        if (
+                self.outputs.get('location')
+                and 'location' in event
+                and event.Decoded('location').decode().strip()
+        ):
             xstr = " [%s]" % (event.Decoded('location').
                               decode().strip())
             self.printer.msg(xstr, 'default')
@@ -847,8 +900,10 @@ class IcalendarInterface:
 
         self.printer.msg('\n')
 
-        if(self.outputs.get('description') and 'description' in event
-           and event.Decoded('description').decode().strip()):
+        if (
+                self.outputs.get('description') and 'description' in event
+                and event.Decoded('description').decode().strip()
+        ):
             descrIndent = outputsIndent + '  '
             box = True  # leave old non-box code for option later
             if box:
@@ -915,8 +970,10 @@ class IcalendarInterface:
         day = ''
 
         for event in eventList:
-            if(self.options['ignore_started'] and
-               (self.decode_dtm(event, 'dtstart') < self.now)):
+            if (
+                    self.options['ignore_started'] and
+                    (self.decode_dtm(event, 'dtstart') < self.now)
+            ):
                 continue
             if self.options['ignore_declined'] and self._DeclinedEvent(
                     event):
@@ -1158,8 +1215,14 @@ class IcalendarInterface:
         # convert start date to the beginning of the week or month
         if cmd == 'calw':
             dayNum = self.cal_monday(int(start.strftime("%w")))
-            start = (start - timedelta(days=dayNum))
-            end = (start + timedelta(days=(count * 7)))
+            start -= timedelta(days=dayNum)
+            weeks = count
+            end = (start + timedelta(days=(weeks * 7)))
+        elif cmd == 'cal5w':
+            dayNum = self.cal_monday(int(start.strftime("%w")))
+            start -= timedelta(days=(dayNum + count * 7))
+            weeks = 2 * count + 1
+            end = (start + timedelta(days=(weeks * 7)))
         else:  # cmd == 'calm':
             start = (start - timedelta(days=(start.day - 1)))
             endMonth = (start.month + 1)
@@ -1175,13 +1238,13 @@ class IcalendarInterface:
                 if offsetDays < 0:
                     offsetDays = 6
             totalDays = (daysInMonth + offsetDays)
-            count = int(totalDays / 7)
+            weeks = int(totalDays / 7)
             if totalDays % 7:
-                count += 1
+                weeks += 1
 
         eventList = self.search_for_events(start, end, None)
 
-        self.GraphEvents(cmd, start, count, eventList)
+        self.GraphEvents(cmd, start, weeks, eventList)
 
     def sync(self):
         r"""Sync calendar
@@ -1401,8 +1464,10 @@ class IcalendarInterface:
                 (old.Decoded('dtend') - old.Decoded('dtstart')))
             if not args.summary:
                 args.summary = old.Decoded('summary').decode()
-            if(not args.time and not (args.start and 'T' in args.start)
-               and self.isallday(old)):
+            if (
+                    not args.time and not (args.start and 'T' in args.start)
+                    and self.isallday(old)
+            ):
                 args.allday = True
             day = args.day or old_start.day
             month = args.month or old_start.month
@@ -1690,6 +1755,10 @@ def repl(ecal=None):
             ecal.CalQuery(
                     'calw', count=FLAGS.weeks, startText=FLAGS.start)
 
+        elif FLAGS.command in ['5w', 'cal5w']:
+            ecal.CalQuery(
+                    'cal5w', count=FLAGS.weeks, startText=FLAGS.start)
+
         elif FLAGS.command in ['m', 'calm']:
             ecal.CalQuery('calm', startText=FLAGS.start)
 
@@ -1716,9 +1785,11 @@ def repl(ecal=None):
                         field=FLAGS.property)
 
         elif FLAGS.command in ['q', 'quit']:
-            if(ecal.backend_cache_dirty and ecal.no_auto_sync
-               and not IcalendarInterface.confirm(
-                   "Changes made in calendar not yet synced. Quit y/n? ")):
+            if (
+                    ecal.backend_cache_dirty and ecal.no_auto_sync
+                    and not IcalendarInterface.confirm(
+                        "Changes made in calendar not yet synced. Quit y/n? ")
+            ):
                 pass
             else:
                 ecal.interactive = False

icalcli-1.0.4/README.md → icalcli-1.0.6/icalcli.egg-info/PKG-INFO

@@ -1,3 +1,25 @@
+Metadata-Version: 2.1
+Name: icalcli
+Version: 1.0.6
+Summary: Icalendar Calendar Command Line Interface
+Home-page: https://github.com/jrvarma/icalcli
+Maintainer: Jayanth R. Varma
+Maintainer-email: jrvarma@gmail.com
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: python-dateutil
+Requires-Dist: parsedatetime
+Requires-Dist: icalendar
+Requires-Dist: recurring_ical_events
+Provides-Extra: parsedatetime
+Requires-Dist: parsedatetime; extra == "parsedatetime"
+
 # icalcli
 
 ### An iCalendar Command Line Interface
@@ -49,6 +71,7 @@ python setup.py install
     edit (e)               edit calendar events
     agenda (g)             get an agenda for a time period
     calw (w)               get a week-based agenda in calendar format
+    cal5w (5w)             get this week / 2 past / 2 future weeks agenda in calendar format
     calm (m)               get a month agenda in calendar format
     add (a)                add a detailed event to the calendar
     search (s)             (regex) search for events 
@@ -70,6 +93,15 @@ backend_interface = ICSInterface("/path/to/ics-file")
 
 ```
 
+#### Example configuration for multiple readonly file_backend
+
+```
+from icalcli import ICSInterface
+
+backend_interface = ICSInterface(["/path/to/ics-file-1", "/path/to/ics-file-2"])
+
+```
+
 #### Example configuration for etesync_backend
 
 This configuration assumes that all the credentials are stored in a plain text (`json`) file. In practice, you would use a more secure storage (perhaps, the `Gnome keyring`) or just read it from the terminal.
@@ -89,6 +121,16 @@ backend_interface = EtesyncInterface(
 ```
 See the [Example code](https://github.com/jrvarma/icalcli/issues/1#issuecomment-979851222) for getting the  `uid` and `authToken` for the `etesync` calendar.
 
+## Recurring events and default search period
+
+`icalcli` understands the `RRULE`, `RDATE`, `EXRULE`, `EXDATE` elements of the `icalendar` specification. These elements can be added while creating or editing events using `--rrule`, `--rdate`, `--exrule` and `--exdate` options.
+
+In most views, the instances of the recurring event are displayed. Since a recurring event can have an unlimited number of instances, searches with no start or end date can produce an unending series of events. By default therefore searches with no start or end date are limited to the previous five years and following five years. These defaults can be changed using the options ` --default_past_years` and `--default_future_years`
+
+## Raw ICS
+
+The `icalendar` specification is quite large and complex, and `icalcli` implements only the most common parts of this specification. It is possible to use the `--raw_ics` option to create/edit event using raw ICS text. 
+
 ## Screenshots
 
 Some screenshots are available at Github:

{icalcli-1.0.4 → icalcli-1.0.6}/setup.py

@@ -5,7 +5,7 @@ with open("README.md", "r") as fh:
     long_description = fh.read()
 
 setup(name='icalcli',
-      version='1.0.4',
+      version='1.0.6',
       maintainer='Jayanth R. Varma',
       maintainer_email='jrvarma@gmail.com',
       description='Icalendar Calendar Command Line Interface',