$ pip install ionical
$ ionical
$ git clone https://github.com/danyul/ionical
$ cd ionical
$ python3 -m venv env
$ source env/bin/activate
$ pip install -e ".[dev]"
$ python -m ionical
Usage: ionical [-h] [-v] [-V]
[-f CONFIG_DIRECTORY] [-d ICS_DIR]
[-g] [-s] [-l [#_COMPARISONS]] [-c [CSV_FILE]]
[-i NAME [NAME ...]]
[-a DATE_OR_NUMBER] [-b DATE_OR_NUMBER] [-t TEXT [TEXT ...]]
Keep an eye on ical! ionical is a CLI tool to track iCalendar changes.
Help/About:
-h, --help Print help message, then exit.
-v, --verbose Increase the level of printed feeedback.
-V, --version Print version, then exit.
File Locations:
Specify expected locations for config files and calendar downloads.
-f CONFIG_DIRECTORY Directory where config file ionical_config.toml located.
This file will contain basic calendar information
(names, URLs for .ics files, and timezones) and allows
various additional configuration options.
See README file for an example, or run 'ionical' to
generate a sample config file which may then be edited.
(default: current directory)
-d ICS_DIR Directory for downloading/accessing .ics files.
(default: current directory)
Actions:
One or more action options MUST be specified.
-g, --get_today Download current .ics files and label them with today's
date. This will be done prior to other actions.
(If this is left unspecified, operations will only use
.ics files that have been previously downloaded.)
-s, --show Display events from most recent ical file version for
each calendar.
-l [#_COMPARISONS] Show changelogs comparing calendar versions from
multiple dates. Optionally, specify the number of
prior versions (per each calendar) for which to show
comparison changelogs. (If left unspecified,
#_COMPARISONS default is 2.)
-c [CSV_FILE] Export calendar events to csv.
Calendar Filters:
Restrict all actions to a subset of calendars.
-i NAME [NAME ...] Only operate on calendars with a specified NAME.
(If -i not specified, operate on every calendar
listed in ionical_config.toml.)
Event Filters:
Filter events shown in changelogs, schedule displays
-a DATE_OR_NUMBER Only include events that start AFTER a specified date.
(I.e., exclude events starting before the date.)
Value must be EITHER a date in format YYYY-MM-DD, or
a positive integer representing # of days in the past
(If option unspecified, default behavior is to exclude
any events starting prior to 1 day ago.)
-b DATE_OR_NUMBER Only include events that start BEFORE a specified date.
(I.e., exclude events starting on or after the date.)
Value must be EITHER a date in format YYYY-MM-DD, or
a positive integer representing # of days in the future.
(If option unspecified, default behavior is to
have no upper limit on event dates.)
-t TEXT [TEXT ...] Only include events whose summary text includes words
that match at least one TEXT item. TEXT items can be
either a single word or phrases comprised of words and
spaces. If the latter, you must enclose TEXT within
quotation marks.
(If option not specified, no text filters are applied.)
# ionical_config.toml
title = "ionical configuration file"
verbose = true
# Note: All options that can be specified on the command line may
# alternatively be specified in this config file. For example,
# uncommenting 'get_today = true' (below) has the same effect as running
# 'ionical -g' (i.e., today's ics files will be downloaded). Likewise,
# uncommenting 'export_csv = ["CAL_1_NAME"]' is equivalent to running
# ionical using the argument/parameter '-i CAL_1_NAME'.
#
# Note: If configuration is specified both in this config file AND via
# a command line argument, the command line argument takes precedence, and
# the information from the config file is ignored.
[actions]
# restrict_to = ["CAL_1_NAME"]
# get_today = true
# show_schedule = true
# show_changelog = true
# num_changelogs = 2
# export_csv = true
[filters]
# earliest = 2020-11-01
# latest = 2022-06-30
# summary_text = ["search text 1", "search text two"]
[calendars]
[calendars.CAL1_NAME]
description = "CAL1_LONG_NAME"
url = "http://url_to_ics_download_for_CAL_1.ics"
tz = "US/Eastern" # or other timezone in pytz format, for CAL1
[calendars.CAL2_NAME]
description = "CAL2_LONG_NAME"
url = "http://url_to_ics_download_for_CAL_2.ics"
tz = "US/Mountain" # or other timezone in pytz format, for CAL2
[event_classifications]
[event_classifications.by_start_time]
[event_classifications.by_start_time.example_time_category]
Morning = [
[5, 12], # Any event starting between 5am and 12pm
] # is categorized as "Morning"
Afternoon = [
[12, 16], # Any event starting between 12p and 4pm
] # is categorized as "Afternoon"
Evening = [
[16, 20], # Any event starting between 4pm and 8pm
] # is categorized as "Evening"
Night = [
[20, 24], # Any event that starts between 8pm
[ 0, 4], # and 4am is categorized as "Night"
]
All-Day = "missing" # If no start time, categorize as "All-Day"
Other = "default" # All other events (in this case, only
# events starting between 4 and 5 am) will
# be categorized as "Unspecified".
[csv]
file = "ionical_export_default_csv_filename.csv"
include_empty_dates = false
grouping = "example_time_category"
order = ["Morning", "Afternoon"]
format = "My morning events: {0} \n My afternoon events: {1}"
text_if_not_present = "I AM AVAILABLE"
[csv.substitutions]
"Secret spy meeting with Carl" = "Going to the zoo"
"Present shopping to suprise JoJo" = "Flossing the cat"
# You can tweak the below to change display formatting
[formatting]
[formatting.schedule_view] # For displaying schedules (-s option):
date_fmt = "%a, %b %d %Y"
time_fmt = "at %I:%M%p"
time_replacements = {" 0" = " ", "(0" = "(", "AM" = "am", "PM" = "pm"}
time_group = "example_time_category"
time_group_fmt = "{:>} Time"
event_summary = " {0:16} {1:10} ({2:<}) {3:30}"
# Meanings for event_summary fields:
# 0: date (further formatted by date_fmt variable)
# 1: time (further formatted by time_fmt and/or time_replacements)
# 2: user_defined time grouping (further formatted by time_group_fmt)
# 3: event summary text
[formatting.changelog] # For displaying changelogs (-l option):
date_fmt = "%a, %b %d %Y"
time_fmt = " %I%p"
time_replacements = {" 0" = " ", "(0" = "(", "AM" = "am", "PM" = "pm"}
change_report = " {label:10}{name:18}{start_str:19} {summary:30} [comp vers:{compare_date}]\\n"
# Meanings for change_report fields:
# label : "ADD" if an event has been added or "REMOVE" if removed
# (modifying a schedule's time or event summary will
# show up as a combination of a removal and an addition).
# name : The Full Name of a calendar.
# start_str : A string representing an event's start date and time.
# summary: : The event's summary text
# compare_date : The date of the second-most-recentics file for this
# calendar, against which the changelog is being compared.
Downloaded .ics files have a filename format of
ABC123__20200314.ics, where "ABC123" is a name
identifier. (A reasonable name for a calendar
which tracks an employee's work schedule might
be a last name or an employee ID number.) Names
should contain only alphanumeric characters.
"20200314" indicates that this particular version
of the calendar was downloaded on March 14, 2020.
Initial release
FAQs
command line tool for tracking ical changes
We found that ionical demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.