chiark - git - matthewv - gooswapper/blob - README.org

   1 * Gooswapper - Exchange / Google calendar sync
   2
   3 This is a python script that synchronises between Exchange and Google
   4 calendars. Currently only one-way synchronisation (from Exchange to
   5 Google) is supported.
   6
   7 Upstream git located [[https://salsa.debian.org/matthew/gooswapper][on salsa]].
   8
   9 ** Dependencies
  10
  11 For the google API, install the ~python3-googleapi~ Debian/Ubuntu
  12 package; for Exchange, install [[https://github.com/ecederstrand/exchangelib][Exchangelib]] at least version 1.12.2,
  13 and make sure it's on your Python path (the code by default adds
  14 ~/upstreams/exchangelib~ ).
  15
  16 ** Usage
  17
  18 #+BEGIN_EXAMPLE
  19 usage: gooswapper.py [-h] [--auth_host_name AUTH_HOST_NAME]
  20                      [--noauth_local_webserver]
  21                      [--auth_host_port [AUTH_HOST_PORT [AUTH_HOST_PORT ...]]]
  22                      [--logging_level {DEBUG,INFO,WARNING,ERROR,CRITICAL}]
  23                      [-g GCALID] [-l]
  24                      exchuser exchemail
  25
  26 Gooswapper calendar sync
  27
  28 positional arguments:
  29   exchuser              Exchange user e.g. 'SANGER\mv3'
  30   exchemail             Exchange calendar email e.g. ISGGroup@sanger.ac.uk
  31
  32 optional arguments:
  33   -h, --help            show this help message and exit
  34   --auth_host_name AUTH_HOST_NAME
  35                         Hostname when running a local web server.
  36   --noauth_local_webserver
  37                         Do not run a local web server.
  38   --auth_host_port [AUTH_HOST_PORT [AUTH_HOST_PORT ...]]
  39                         Port web server should listen on.
  40   --logging_level {DEBUG,INFO,WARNING,ERROR,CRITICAL}
  41                         Set the logging level of detail.
  42   -g GCALID, --gcalid GCALID
  43                         google Calendar ID
  44   -l, --loop            keep running indefinitely
  45 #+END_EXAMPLE
  46
  47 ** Bugs / Limitations
  48
  49 See [[file:NOTES.org][NOTES.org]] in the distribution for things that I know need doing;
  50 feel free to supply patches...