~canonical-hwe-team/pm-graph/master

« back to all changes in this revision

Viewing changes to README.googlesheet

  • Committer: Todd Brandt
  • Date: 2019-09-05 20:10:27 UTC
  • Revision ID: git-v1:03b75f86e03a68331a288823a9d5ded9cde42bf7
googlesheet:
- add better header comments
- add README.googlesheet

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
------------------------------------------------------------------
 
2
|                          OVERVIEW                              |
 
3
------------------------------------------------------------------
 
4
 
 
5
 The googlesheet tool is used to Summarize sleepgraph multitests
 
6
 in the form of googlesheets. This tool searches a dir for sleepgraph
 
7
 multitest folders and generates google sheet summaries for them.
 
8
 It can also generate a high level summary of all the multtests found
 
9
 for quick viewing and analysis.
 
10
 
 
11
------------------------------------------------------------------
 
12
|                           SETUP                                |
 
13
------------------------------------------------------------------
 
14
 
 
15
 This tool requires several python packages and libraries beyond what
 
16
 the base ubuntu build provides. The requirements are different for
 
17
 python2 vs python3, however both should be able to run the tool.
 
18
 
 
19
 [python2 debian package requirements]
 
20
 sudo apt-get install python-configparser python-requests python-psutil python-httplib2 python-pip
 
21
 sudo pip2 install --upgrade google-api-python-client oauth2client
 
22
 
 
23
 [python3 debian package requirements]
 
24
 sudo apt-get install python3-psutil python3-pip
 
25
 sudo pip3 install --upgrade google-api-python-client oauth2client
 
26
 
 
27
 Once the libraries are fully installed, the "googlesheet.py -h" help
 
28
 text should be viewable.
 
29
 
 
30
 In order to get the tool to interface with google drive, you must
 
31
 create a "credentials.json" file with your encrypted login info.
 
32
 You do this by running "googlesheet.py -setup". It will open a broswer
 
33
 window and ask you to login from the GUI.
 
34
 
 
35
 To run -setup without local browser use this command:
 
36
  ./googlesheet.py -setup --noauth_local_webserver
 
37
 
 
38
 It will generate a link that you must click elsewhere in a browser
 
39
 to login and enable the tool. Once you've finished with the UI, it
 
40
 will give you a KEY which you must paste into the googlesheet stdin.
 
41
 It will verify the key and download a credentials.json file for you.