Merge pull request #10 from martinm76/sortedevents

Updated ical2txt.py with fixes for a couple of possible index errors and support for recurring events.
This commit is contained in:
Erik 2021-04-05 11:34:06 -07:00 committed by GitHub
commit cb2bc45191
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 60 additions and 31 deletions

View File

@ -35,6 +35,7 @@ Download the script or clone the project and get it from there.
* ***icalendar*** (pip3 install icalendar) * ***icalendar*** (pip3 install icalendar)
* [**Homepage**](http://icalendar.readthedocs.org/) * [**Homepage**](http://icalendar.readthedocs.org/)
* [**Code**](http://github.com/collective/icalendar) * [**Code**](http://github.com/collective/icalendar)
* ***recurring-ical-events*** (pip3 install recurring-ical-events)
## Usage of ical2txt ## Usage of ical2txt
@ -42,6 +43,14 @@ Call the script and pass in the location of the ics file.
Ex: `python ical2txt.py event.ics` / `python3 ical2txt.py event.ics` Ex: `python ical2txt.py event.ics` / `python3 ical2txt.py event.ics`
Note: You can limit output to a certain time period. Useful for week logs and the like:
`./ical2txt.py myexport.ics 20210101 20211231`
`./ical2txt.py myexport.ics 2021-01-01T00:00:00 2021-01-31T23:59:59`
**NEW AS OF 2021-03-28:** Recurring events are now actually processed in ical2txt.py. If no end date is given 5 years from now is chosen.
## Contributing ## Contributing
1. Fork it! 1. Fork it!

View File

@ -3,13 +3,21 @@
import sys import sys
import os.path import os.path
from icalendar import Calendar from icalendar import Calendar
import csv import recurring_ical_events
from bs4 import BeautifulSoup from bs4 import BeautifulSoup
import warnings import warnings
from dateutil.parser import parse from dateutil.parser import parse
import datetime
warnings.filterwarnings("ignore", category=UserWarning, module='bs4') # We don't want warnings about URL's. We just what the URL printed, if there. warnings.filterwarnings("ignore", category=UserWarning, module='bs4') # We don't want warnings about URL's. We just what the URL printed, if there.
if len(sys.argv) <= 1:
print("Please call this script with an ics-file as parameter.\n")
print("Even better, call it with start and end dates:\n")
print(sys.argv[0] + " myexport.ics 20210101 20210201")
print(sys.argv[0] + " myexport.ics 2021-01-01T00:00:00 2021-01-31T23:59:59\n")
exit(1)
filename = sys.argv[1] filename = sys.argv[1]
# TODO: use regex to get file extension (chars after last period), in case it's not exactly 3 chars. # TODO: use regex to get file extension (chars after last period), in case it's not exactly 3 chars.
file_extension = str(sys.argv[1])[-3:] file_extension = str(sys.argv[1])[-3:]
@ -49,31 +57,33 @@ def removehtml(html):
return text return text
def open_cal(): def open_cal():
if os.path.isfile(filename): if os.path.isfile(filename):
if file_extension == 'ics': if file_extension == 'ics':
print("Extracting events from file:", filename, "\n") print("Extracting events from file:", filename, "\n")
f = open(sys.argv[1], 'rb') f = open(sys.argv[1], 'rb')
gcal = Calendar.from_ical(f.read()) gcal = Calendar.from_ical(f.read())
revents = recurring_ical_events.of(gcal).between(istart,istop)
for component in gcal.walk(): # for component in gcal.walk():
for component in revents:
event = CalendarEvent("event") event = CalendarEvent("event")
if component.get('TRANSP') == 'TRANSPARENT': continue #skip event that have not been accepted v=(dir(component).count('get')) # Only proces data if object is a valid event
if component.get('SUMMARY') == None: continue #skip blank items if (v != 0):
event.summary = component.get('SUMMARY') if component.get('TRANSP') == 'TRANSPARENT': continue #skip all day events and the like
event.uid = component.get('UID') if component.get('SUMMARY') == None: continue #skip blank items
if component.get('DESCRIPTION') == None: continue #skip blank items event.summary = component.get('SUMMARY')
event.description = component.get('DESCRIPTION') event.uid = component.get('UID')
event.location = component.get('LOCATION') if component.get('DESCRIPTION') == None: continue #skip blank items
if hasattr(component.get('dtstart'), 'dt'): event.description = component.get('DESCRIPTION')
event.start = component.get('dtstart').dt event.location = component.get('LOCATION')
if hasattr(component.get('dtend'), 'dt'): if hasattr(component.get('dtstart'), 'dt'):
event.end = component.get('dtend').dt event.start = component.get('dtstart').dt
if hasattr(component.get('dtend'), 'dt'):
event.end = component.get('dtend').dt
event.url = component.get('URL')
event.url = component.get('URL') events.append(event)
events.append(event)
f.close() f.close()
else: else:
print("You entered ", filename, ". ") print("You entered ", filename, ". ")
@ -91,13 +101,7 @@ def txt_write(icsfile):
spent=0 spent=0
evcount=0 evcount=0
evskip=0 evskip=0
istart=0 sys.stdout.write("Processing events : ")
istop=4102441200.0 # The year 2100. Hopefully this will not be in use by then ...
if sys.argv[2] != '':
istart=parse(sys.argv[2]).timestamp()
if sys.argv[3] != '':
istop=parse(sys.argv[3]).timestamp()
print("Processing events :", end=" ")
try: try:
with open(txtfile, 'w') as myfile: with open(txtfile, 'w') as myfile:
for event in sortedevents: for event in sortedevents:
@ -108,7 +112,7 @@ def txt_write(icsfile):
tm=divmod(spent, 3600)[1]/60 tm=divmod(spent, 3600)[1]/60
myfile.write("\nTime Total: " + '{:02.0f}'.format(th) + ":" + '{:02.0f}'.format(tm) + "\n") myfile.write("\nTime Total: " + '{:02.0f}'.format(th) + ":" + '{:02.0f}'.format(tm) + "\n")
spent=0 spent=0
if event.start.timestamp() > istart and event.start.timestamp() < istop: if event.start.timestamp() > istart.timestamp() and event.start.timestamp() < istop.timestamp():
if prevdate != event.start.strftime("%Y-%m-%d"): # Make a header for each day if prevdate != event.start.strftime("%Y-%m-%d"): # Make a header for each day
prevdate = event.start.strftime("%Y-%m-%d") prevdate = event.start.strftime("%Y-%m-%d")
myfile.write("\nWorklog, " + prevdate + "\n===================\n") myfile.write("\nWorklog, " + prevdate + "\n===================\n")
@ -119,7 +123,7 @@ def txt_write(icsfile):
hours = divmod(ds, 3600)[0] hours = divmod(ds, 3600)[0]
minutes = divmod(ds,3600)[1]/60 minutes = divmod(ds,3600)[1]/60
description=removehtml(event.description.encode('utf-8').decode()) description=removehtml(event.description.encode('utf-8').decode())
values = event.start.strftime("%H:%M:%S") + " - " + event.end.strftime("%H:%M:%S") + " (" + '{:02.0f}'.format(hours) + ":" + '{:02.0f}'.format(minutes) + ") " + event.summary.encode('utf-8').decode() values = event.start.strftime("%H:%M") + " - " + event.end.strftime("%H:%M") + " (" + '{:02.0f}'.format(hours) + ":" + '{:02.0f}'.format(minutes) + ") " + event.summary.encode('utf-8').decode()
if event.location != '': values = values + " [" + event.location + "]" # Only include location if there is one if event.location != '': values = values + " [" + event.location + "]" # Only include location if there is one
# Remove Google Meet and Skype Meeting part of description # Remove Google Meet and Skype Meeting part of description
@ -129,12 +133,18 @@ def txt_write(icsfile):
if description != '': if description != '':
values = values + "\n" + description + "\n" values = values + "\n" + description + "\n"
myfile.write(values+"\n") myfile.write(values+"\n")
print("", end=".") sys.stdout.write(".")
sys.stdout.flush()
evcount+=1 evcount+=1
else: else:
print("", end="S") sys.stdout.write("S")
sys.stdout.flush()
evskip+=1 evskip+=1
th=divmod(spent, 3600)[0]
tm=divmod(spent, 3600)[1]/60
myfile.write("\nTime Total: " + '{:02.0f}'.format(th) + ":" + '{:02.0f}'.format(tm) + "\n")
print("\n\nWrote " + str(evcount) + " events to ", txtfile, " and skipped ", str(evskip), " events\n") print("\n\nWrote " + str(evcount) + " events to ", txtfile, " and skipped ", str(evskip), " events\n")
except IOError: except IOError:
print("Could not open file!") print("Could not open file!")
@ -151,7 +161,17 @@ def debug_event(class_name):
print(class_name.end) print(class_name.end)
print(class_name.url, "\n") print(class_name.url, "\n")
open_cal() now=datetime.datetime.now()
sortedevents=sorted(events, key=lambda obj: obj.start) istart=datetime.datetime.fromtimestamp(0) # Start of UNIX epoch (1970-01-01T00:00:00)
txt_write(filename) istop=now+datetime.timedelta(seconds=157680000) # Stop 5 years in the future, if no enddate is given, to make sure reucurring events don't go on forever ...
if len(sys.argv) > 3:
if sys.argv[2] != '':
istart=parse(sys.argv[2])
if sys.argv[3] != '':
istop=parse(sys.argv[3])
open_cal() # Open ics file and do initial parsing of events
sortedevents=sorted(events, key=lambda obj: obj.start) # Make sure events are in chronological order
txt_write(filename) # Write the matching events to the textfile. With recurring_ical_events, scoping is already done.
#debug_event(event) #debug_event(event)