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