README: Initial commit.

README.md

@@ -0,0 +1,35 @@
+# RT-Client-Tools
+
+## Installation
+
+Just copy the scripts into a directory in your `$PATH`.
+
+Dependencies are:
+
+* Python 3
+* PyYAML (`python3-pyyaml` in Debian)
+* The `rt` CLI tool needs to be installed and configured
+
+## rt-bulk-send
+
+This tool can send correspondence, or make a comment, on every ticket that matches an RT search.
+
+## rt-auto-remind
+
+This tool lets you run `rt-bulk-send` on a timer.  You specify a range on a ticket's date field as part of your search.  For example, you can send mail on all non-closed tickets in your queue with Due dates that are between 10 and 15 days out:
+
+    $ rt-auto-remind Due 10 15 'Queue = MyQueue and Status != __inactive__' my_mail.txt
+
+Then you can run this command again tomorrow, and it will only send mail to tickets that have come due since the last run.  In other words, it remembers what searches it has already run, and never searches over the same date range twice.  This makes it suitable to run from a systemd timer or cron.
+
+## rt-send-all-reminders
+
+This is a convenience wrapper for `rt-auto-remind`.  You can specify your reminders in a YAML file, and this tool will call `rt-auto-remind` for each and report the result.
+
+## License and Copyright
+
+Copyright © 2018 Brett Smith <brettcsmith@brettcsmith.org>
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this software except in compliance with the License. You may obtain a copy of the License at <http://www.apache.org/licenses/LICENSE-2.0>.
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.