comparison README.txt @ 91:ae3f20933758

Update documentation a bit.
author Matti Hamalainen <ccr@tnsp.org>
date Wed, 27 Jul 2016 13:09:18 +0300
parents 286ccecf9257
children f6836a604322
comparison
equal deleted inserted replaced
90:286ccecf9257 91:ae3f20933758
25 (shared or not) can be viewed through the main calendar site, the 25 (shared or not) can be viewed through the main calendar site, the
26 amalgamate view can't be shared or viewed as an embedded element 26 amalgamate view can't be shared or viewed as an embedded element
27 directly. 27 directly.
28 28
29 29
30 How to use 30 Installation
31 ========== 31 ============
32 32
33 First, we need to install the required Python tools in order to 33 First, we need to install the required Python tools in order to
34 install the required Google API Python modules ... in Debian/Ubuntu, 34 install the required Google API Python modules ... in Debian,
35 chant the following magic incantations: 35 chant the following magic incantations:
36 36
37 $ sudo apt-get install python-pip python-setuptools python-wheel 37 $ sudo apt-get install python-pip python-setuptools python-wheel
38
39 In Ubuntu and other distributions package names may be different.
40
38 41
39 Then, use PIP to install Google API stuff locally for the user .. 42 Then, use PIP to install Google API stuff locally for the user ..
40 43
41 $ pip install --upgrade google-api-python-client 44 $ pip install --upgrade google-api-python-client
42 45
43 -- 46 If the installation passes without errors, you are good to go.
44
45 At this point, you will need to enable the Calendar API from 47 At this point, you will need to enable the Calendar API from
46 Google's control panel. Refer to the following web page: 48 Google's control panel. Refer to the following web page:
47 49
48 https://developers.google.com/google-apps/calendar/quickstart/python 50 https://developers.google.com/google-apps/calendar/quickstart/python
49 51
50 The section "Step 1" has the instructions. We've already done "Step 2", 52 The section "Step 1" has the instructions. We've already done "Step 2",
51 which is incomplete in the guide anyway. 53 which is incomplete in the guide anyway.
52 54
53 --
54 55
55 Finally, edit example.cfg and run multimerge with config file as 56 Configuration and usage
56 command line parameter (if no configuration file is specified, 57 =======================
57 certain default settings will be used): 58
59 Edit example.cfg and run multimerge with config file as command line
60 parameter. At the very least, you will need to define the "dest_name"
61 and "dest_regex" settings in the configuration. The settings are
62 described in the example configuration file.
58 63
59 $ ./multimerge.py example.cfg 64 $ ./multimerge.py example.cfg
60 65
61 On first run, you will need to authenticate Multimerge to allow 66 On first run, you will need to authenticate Multimerge to allow
62 access to the target calendar. You copy & paste the generated URL 67 access to the target calendar. You copy & paste the generated URL