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

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