sunscript/sunscript.py at master · h4-n1/sunscript · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
from datetime import datetime, date, timezone, timedelta
import pytz

### ALL USER INPUT HERE
# define location and date range
loc_name = 'Toronto'
# what's the point of the region definition?
loc_region = 'Ontario'
loc_lat = 43.651070
loc_long = -79.347015
# is there a better way to define timezone?
loc_tz = 'America/Toronto'
date_start = date(2021, 1, 1)
# daterange function is exclusive of end date
date_end = date(2022, 1, 1)
output_filename = 'sun_{0}_{1}_{2}.ics'.format(loc_name.lower(), date_start, date_end)

### ASTRAL STUFF
# https://astral.readthedocs.io/en/latest/index.html
from astral import LocationInfo
from astral.sun import dawn, sunrise, sunset, dusk

# set location
loc = LocationInfo(loc_name, loc_region, loc_tz, loc_lat, loc_long)

### ICAL STUFF
# https://icalendar.readthedocs.io/en/latest/usage.html#example
from icalendar import Calendar, Event, vDatetime, vText

#>init the calendar
cal = Calendar()
#>compliance properties
# https://www.kanzaki.com/docs/ical/prodid.html
cal.add('prodid', '-//sunscript//h4n1//')
# https://www.kanzaki.com/docs/ical/version.html
cal.add('version', '2.0')

# from https://stackoverflow.com/a/1060330
def daterange(start_date, end_date):
    for n in range(int((end_date - start_date).days)):
        yield start_date + timedelta(n)
# could possibly also use dateutil module

for loc_date in daterange(date_start, date_end):

    ### time vars

    time_dawn = dawn(loc.observer, loc_date, tzinfo=loc_tz)
    time_rise = sunrise(loc.observer, loc_date, tzinfo=loc_tz)
    time_set = sunset(loc.observer, loc_date, tzinfo=loc_tz)
    time_dusk = dusk(loc.observer, loc_date, tzinfo=loc_tz)

    ### description vars

    event_title_rise = '↑ {0}'.format(time_rise.strftime("%H:%M"))
    event_title_set = '↓ {0}'.format(time_set.strftime("%H:%M"))

    # could move coordinates to 'GEO' property, see https://www.kanzaki.com/docs/ical/geo.html
    event_location = vText('{0} / {1}, {2}'.format(loc_name, loc_lat, loc_long))

    # timedelta doesn't allow strftime, find a way to format it better, see https://stackoverflow.com/questions/538666/format-timedelta-to-string
    event_desc_rise = 'Dawn at {0}, sunrise at {1}. Total sunlight time {2}'.format(time_dawn.strftime("%H:%M"), time_rise.strftime("%H:%M"), str(time_set - time_rise))

    event_desc_set = 'Sunset at {0}, dusk at {1}. Total sunlight time {2}'.format(time_set.strftime("%H:%M"), time_dusk.strftime("%H:%M"), str(time_set - time_rise))

    # dawn to sunrise
    daystart = Event()
    daystart.add('summary', event_title_rise)
    daystart['uid'] = '{0}/SUNSCRIPT/SUNRISE/{1}'.format(loc_date, loc_name.upper())
    daystart.add('dtstamp', datetime.now(timezone.utc))
    daystart['location'] = event_location
    daystart['description'] = event_desc_rise
    daystart.add('dtstart', time_dawn)
    daystart.add('dtend', time_rise)
    cal.add_component(daystart)

    # sunset to dusk
    dayend = Event()
    dayend.add('summary', event_title_set)
    dayend['uid'] = '{0}/SUNSCRIPT/SUNSET/{1}'.format(loc_date, loc_name.upper())
    dayend.add('dtstamp', datetime.now(timezone.utc))
    dayend['location'] = event_location
    dayend['description'] = event_desc_set
    dayend.add('dtstart', time_set)
    dayend.add('dtend', time_dusk)
    cal.add_component(dayend)

# write to disk
import os
f=open(output_filename, 'wb')
f.write(cal.to_ical())