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]] at least version 1.12.2, and make sure
  12 it's on your Python path (the code by default adds
  13 ~/upstreams/exchangelib~ ).
  14
  15 ** Usage
  16
  17 #+BEGIN_EXAMPLE
  18 usage: gooswapper.py [-h] [--auth_host_name AUTH_HOST_NAME]
  19                      [--noauth_local_webserver]
  20                      [--auth_host_port [AUTH_HOST_PORT [AUTH_HOST_PORT ...]]]
  21                      [--logging_level {DEBUG,INFO,WARNING,ERROR,CRITICAL}]
  22                      [-g GCALID] [-l]
  23                      exchuser exchemail
  24
  25 Gooswapper calendar sync
  26
  27 positional arguments:
  28   exchuser              Exchange user e.g. 'SANGER\mv3'
  29   exchemail             Exchange calendar email e.g. ISGGroup@sanger.ac.uk
  30
  31 optional arguments:
  32   -h, --help            show this help message and exit
  33   --auth_host_name AUTH_HOST_NAME
  34                         Hostname when running a local web server.
  35   --noauth_local_webserver
  36                         Do not run a local web server.
  37   --auth_host_port [AUTH_HOST_PORT [AUTH_HOST_PORT ...]]
  38                         Port web server should listen on.
  39   --logging_level {DEBUG,INFO,WARNING,ERROR,CRITICAL}
  40                         Set the logging level of detail.
  41   -g GCALID, --gcalid GCALID
  42                         google Calendar ID
  43   -l, --loop            keep running indefinitely
  44 #+END_EXAMPLE
  45
  46 ** Bugs / Limitations
  47
  48 See [[file:NOTES.org][NOTES.org]] in the distribution for things that I know need doing;
  49 feel free to supply patches...