# HG changeset patch # User Sean E. Russell # Date 1634157565 18000 # Wed Oct 13 15:39:25 2021 -0500 # Node ID 44ff72cef5a339bf24e953bcc676d20bdbd5ecef # Parent 4c41f0882a59ae83dff3ffcdd87745414e57134b Documentation. The project is now nearly 50% documentation. diff --git a/CHANGELOG b/CHANGELOG new file mode 100644 --- /dev/null +++ b/CHANGELOG @@ -0,0 +1,18 @@ +# Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +> **Types of changes**: +> +> - **Added**: for new features. +> - **Changed**: for changes in existing functionality. +> - **Deprecated**: for soon-to-be removed features. +> - **Removed**: for now removed features. +> - **Fixed**: for any bug fixes. +> - **Security**: in case of vulnerabilities. + +## [v1.0.0] 2021-10-13 + +Initial upload diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,24 @@ +Copyright (c) 2021, Sean E. Russell +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. + * Neither the name of the nor the + names of its contributors may be used to endorse or promote products + derived from this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL BE LIABLE FOR ANY +DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND +ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +importicals +=========== + +A small utility script to keep a +[remind](https://dianne.skoll.ca/projects/remind/) DB updated from a calendar +directory. + +This is a one-way, incomplete sync. Reminders are not deleted, and created +reminders do not create ical entries. + +The reason for this tool is as part of a toolchain using +[vdirsyncer](https://vdirsyncer.readthedocs.org/) and +[khal](https://lostpackets.de/khal/). vdirsyncer keeps a local directory in sync +with a remote WebDAV server; khal is used as the calendaring app. However, khal +has no provision for alerts; this tool bridges that gap by creating reminders +from the ics. + +Most of the heavy lifting is done by other tools; dependencies include: + +1. [bar](http://www.theiling.de/projects/bar.html), for big imports +2. [ical2rem](http://tim.stoakes.net/remind/), which does the actual ical -> + reminder conversion +3. [fswatch](https://emcrisostomo.github.io/fswatch/), responsible for noticing + when new calendar entries are added +4. [remind](https://dianne.skoll.ca/projects/remind/) (indirect), which is what + ical2rem creates events for + +So, really all this script does is glue it all together. Oh, if you want to be +actually *alerted*, you'll have to wire that up to remind, too, however you're +going to do it.