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