mirror of
https://github.com/taigrr/wtf
synced 2025-01-18 04:03:14 -08:00
Add basic documentation for Google Spreadsheet module
This commit is contained in:
Chris Cummer
parent
78fd0ca40b
commit
3e27166858
@ -19,11 +19,7 @@ wtf/gcal/
|
||||
|
||||
## Required ENV Variables
|
||||
|
||||
<span class="caption">Key:</span> `WTF_GOOGLE_CAL_CLIENT_ID` <br />
|
||||
<span class="caption">Value:</span> Your <a href="https://developers.google.com/calendar/auth">Google API</a> client ID.
|
||||
|
||||
<span class="caption">Key:</span> `WTF_GOOGLE_CAL_CLIENT_SECRET` <br />
|
||||
<span class="caption">Value:</span> Your <a href="https://developers.google.com/calendar/auth">Google API</a> client secret.
|
||||
None.
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
|
||||
70
_site/content/posts/modules/gspreadsheets.md
Normal file
70
_site/content/posts/modules/gspreadsheets.md
Normal file
@ -0,0 +1,70 @@
|
||||
---
|
||||
title: "Google Spreadsheets"
|
||||
date: 2018-06-10T18:26:26-04:00
|
||||
draft: false
|
||||
---
|
||||
|
||||
Added in `v0.0.7`.
|
||||
|
||||
Display information
|
||||
|
||||
```bash
|
||||
wtf/gspreadsheets/
|
||||
```
|
||||
|
||||
## Required ENV Variables
|
||||
|
||||
None.
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
None.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
gspreadsheets:
|
||||
colors:
|
||||
values: "green"
|
||||
cells:
|
||||
names:
|
||||
- "Cell 1 name"
|
||||
- "Cell 2 name"
|
||||
addresses:
|
||||
- "A1"
|
||||
- "A2"
|
||||
enabled: true
|
||||
position:
|
||||
top: 0
|
||||
left: 0
|
||||
width: 1
|
||||
height: 1
|
||||
refreshInterval: "300"
|
||||
secretFile: "~/.wtf/gspreadsheets/client_secret.json"
|
||||
sheetId: "id_of_google_spreadsheet"
|
||||
```
|
||||
|
||||
### Attributes
|
||||
|
||||
`colors.values` <br />
|
||||
The color to display the cell values in. <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11 color</a> name.
|
||||
|
||||
`cells.names` <br />
|
||||
|
||||
`cells.addresses` <br />
|
||||
|
||||
`enabled` <br />
|
||||
Whether or not this module is executed and if its data displayed onscreen. <br />
|
||||
Values: `true`, `false`.
|
||||
|
||||
`position` <br />
|
||||
Where in the grid this module's widget will be displayed. <br />
|
||||
|
||||
`refreshInterval` <br />
|
||||
How often, in seconds, this module will update its data. <br />
|
||||
Values: A positive integer, `0..n`.
|
||||
|
||||
`secretFile` <br />
|
||||
Your <a href="https://developers.google.com/sheets/api/quickstart/go">Google client secret</a> JSON file. <br />
|
||||
Values: A string representing a file path to the JSON secret file.
|
||||
@ -25,6 +25,8 @@ None.
|
||||
|
||||
## Configuration
|
||||
|
||||
### Single Jira Project
|
||||
|
||||
```yaml
|
||||
jira:
|
||||
colors:
|
||||
@ -40,7 +42,32 @@ jira:
|
||||
left: 1
|
||||
height: 1
|
||||
width: 2
|
||||
project: "JIRA"
|
||||
project: "ProjectA"
|
||||
refreshInterval: 900
|
||||
username: "chris.cummer"
|
||||
```
|
||||
|
||||
### Multiple Jira Projects
|
||||
|
||||
If you want to monitor multiple Jira projects, use the following
|
||||
configuration (note the difference in `project`):
|
||||
|
||||
```yaml
|
||||
jira:
|
||||
colors:
|
||||
rows:
|
||||
even: "lightblue"
|
||||
odd: "white"
|
||||
domain: "https://umbrellacorp.atlassian.net"
|
||||
email: "chriscummer@me.com"
|
||||
enabled: true
|
||||
jql: "issueType = Story"
|
||||
position:
|
||||
top: 4
|
||||
left: 1
|
||||
height: 1
|
||||
width: 2
|
||||
project: ["ProjectA", "ProjectB"]
|
||||
refreshInterval: 900
|
||||
username: "chris.cummer"
|
||||
```
|
||||
|
||||
@ -6,11 +6,26 @@
|
||||
<description>Recent content on WTF - A Terminal Dashboard</description>
|
||||
<generator>Hugo -- gohugo.io</generator>
|
||||
<language>en-us</language>
|
||||
<lastBuildDate>Mon, 04 Jun 2018 20:06:40 -0700</lastBuildDate>
|
||||
<lastBuildDate>Sun, 10 Jun 2018 18:26:26 -0400</lastBuildDate>
|
||||
|
||||
<atom:link href="https://wtfutil.com/index.xml" rel="self" type="application/rss+xml" />
|
||||
|
||||
|
||||
<item>
|
||||
<title>Google Spreadsheets</title>
|
||||
<link>https://wtfutil.com/posts/modules/gspreadsheets/</link>
|
||||
<pubDate>Sun, 10 Jun 2018 18:26:26 -0400</pubDate>
|
||||
|
||||
<guid>https://wtfutil.com/posts/modules/gspreadsheets/</guid>
|
||||
<description>Added in v0.0.7.
|
||||
Display information
|
||||
wtf/gspreadsheets/ Required ENV Variables None.
|
||||
Keyboard Commands None.
|
||||
Configuration gspreadsheets:colors:values:&#34;green&#34;cells:names:-&#34;Cell 1 name&#34;-&#34;Cell 2 name&#34;addresses:-&#34;A1&#34;-&#34;A2&#34;enabled:trueposition:top:0left:0width:1height:1refreshInterval:&#34;300&#34;secretFile:&#34;~/.wtf/gspreadsheets/client_secret.json&#34;sheetId:&#34;id_of_google_spreadsheet&#34; Attributes colors.values The color to display the cell values in. Values: Any X11 color name.
|
||||
cells.names cells.addresses enabled Whether or not this module is executed and if its data displayed onscreen. Values: true, false.
|
||||
position Where in the grid this module&rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data.</description>
|
||||
</item>
|
||||
|
||||
<item>
|
||||
<title>Bittrex</title>
|
||||
<link>https://wtfutil.com/posts/modules/cryptocurrencies/bittrex/</link>
|
||||
@ -174,10 +189,8 @@ Key: j Action: Select the next item in the list.</description>
|
||||
<description>Displays all Jira issues assigned to you for the specified project.
|
||||
Source Code wtf/jira/ Required ENV Variables Key: WTF_JIRA_API_KEY Value: Your Jira API key.
|
||||
Keyboard Commands None.
|
||||
Configuration jira:colors:rows:even:&#34;lightblue&#34;odd:&#34;white&#34;domain:&#34;https://umbrellacorp.atlassian.net&#34;email:&#34;chriscummer@me.com&#34;enabled:truejql:&#34;issueType = Story&#34;position:top:4left:1height:1width:2project:&#34;JIRA&#34;refreshInterval:900username:&#34;chris.cummer&#34; Attributes colors.rows.even Define the foreground color for even-numbered rows. Values: Any X11 color name.
|
||||
colors.rows.odd Define the foreground color for odd-numbered rows. Values: Any X11 color name.
|
||||
domain Your Jira corporate domain. Values: A valid URI.
|
||||
email The email address associated with your Jira account.</description>
|
||||
Configuration Single Jira Project jira:colors:rows:even:&#34;lightblue&#34;odd:&#34;white&#34;domain:&#34;https://umbrellacorp.atlassian.net&#34;email:&#34;chriscummer@me.com&#34;enabled:truejql:&#34;issueType = Story&#34;position:top:4left:1height:1width:2project:&#34;ProjectA&#34;refreshInterval:900username:&#34;chris.cummer&#34; Multiple Jira Projects If you want to monitor multiple Jira projects, use the following configuration (note the difference in project):
|
||||
jira:colors:rows:even:&#34;lightblue&#34;odd:&#34;white&#34;domain:&#34;https://umbrellacorp.atlassian.net&#34;email:&#34;chriscummer@me.com&#34;enabled:truejql:&#34;issueType = Story&#34;position:top:4left:1height:1width:2project:[&#34;ProjectA&#34;,&#34;ProjectB&#34;]refreshInterval:900username:&#34;chris.cummer&#34; Attributes colors.rows.even Define the foreground color for even-numbered rows. Values: Any X11 color name.</description>
|
||||
</item>
|
||||
|
||||
<item>
|
||||
@ -188,9 +201,9 @@ email The email address associated with your Jira account.</description>
|
||||
<guid>https://wtfutil.com/posts/modules/gcal/</guid>
|
||||
<description>Displays your upcoming Google calendar events.
|
||||
Not: Setting up access to Google Calendars for Go is a bit unobvious. Check out Google&rsquo;s Go Quickstart first and if you have problems, then take a look at this comment by WesleydeSouza which offers a slightly different approach.
|
||||
Source Code wtf/gcal/ Required ENV Variables Key: WTF_GOOGLE_CAL_CLIENT_ID Value: Your Google API client ID.
|
||||
Key: WTF_GOOGLE_CAL_CLIENT_SECRET Value: Your Google API client secret.
|
||||
Keyboard Commands None.</description>
|
||||
Source Code wtf/gcal/ Required ENV Variables None.
|
||||
Keyboard Commands None.
|
||||
Configuration gcal:colors:title:&#34;red&#34;description:&#34;lightblue&#34;highlights:-[&#39;1on1|1\/11&#39;,&#39;green&#39;]-[&#39;apple|google|aws&#39;,&#39;blue&#39;]-[&#39;interview|meet&#39;,&#39;magenta&#39;]-[&#39;lunch&#39;,&#39;yellow&#39;]past:&#34;gray&#34;conflictIcon:&#34;🚨&#34;currentIcon:&#34;💥&#34;displayResponseStatus:trueemail:&#34;chriscummer@me.com&#34;enabled:trueeventCount:12position:top:0left:0height:4width:1refreshInterval:300secretFile:&#34;~/.wtf/gcal/client_secret.json&#34;withLocation:true Attributes colors.title The default colour for calendar event titles. Values: Any X11 color name.</description>
|
||||
</item>
|
||||
|
||||
<item>
|
||||
|
||||
@ -99,6 +99,13 @@
|
||||
<h1 class="title">Posts</h1>
|
||||
<ul class="posts">
|
||||
<li>
|
||||
<span>
|
||||
<a href="https://wtfutil.com/posts/modules/gspreadsheets/">Google Spreadsheets</a>
|
||||
|
||||
<time class="pull-right post-list">Jun 10, 2018</time>
|
||||
|
||||
</span>
|
||||
</li><li>
|
||||
<span>
|
||||
<a href="https://wtfutil.com/posts/modules/cryptocurrencies/bittrex/">Bittrex</a>
|
||||
|
||||
|
||||
@ -6,11 +6,26 @@
|
||||
<description>Recent content in Posts on WTF - A Terminal Dashboard</description>
|
||||
<generator>Hugo -- gohugo.io</generator>
|
||||
<language>en-us</language>
|
||||
<lastBuildDate>Mon, 04 Jun 2018 20:06:40 -0700</lastBuildDate>
|
||||
<lastBuildDate>Sun, 10 Jun 2018 18:26:26 -0400</lastBuildDate>
|
||||
|
||||
<atom:link href="https://wtfutil.com/posts/index.xml" rel="self" type="application/rss+xml" />
|
||||
|
||||
|
||||
<item>
|
||||
<title>Google Spreadsheets</title>
|
||||
<link>https://wtfutil.com/posts/modules/gspreadsheets/</link>
|
||||
<pubDate>Sun, 10 Jun 2018 18:26:26 -0400</pubDate>
|
||||
|
||||
<guid>https://wtfutil.com/posts/modules/gspreadsheets/</guid>
|
||||
<description>Added in v0.0.7.
|
||||
Display information
|
||||
wtf/gspreadsheets/ Required ENV Variables None.
|
||||
Keyboard Commands None.
|
||||
Configuration gspreadsheets:colors:values:&#34;green&#34;cells:names:-&#34;Cell 1 name&#34;-&#34;Cell 2 name&#34;addresses:-&#34;A1&#34;-&#34;A2&#34;enabled:trueposition:top:0left:0width:1height:1refreshInterval:&#34;300&#34;secretFile:&#34;~/.wtf/gspreadsheets/client_secret.json&#34;sheetId:&#34;id_of_google_spreadsheet&#34; Attributes colors.values The color to display the cell values in. Values: Any X11 color name.
|
||||
cells.names cells.addresses enabled Whether or not this module is executed and if its data displayed onscreen. Values: true, false.
|
||||
position Where in the grid this module&rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data.</description>
|
||||
</item>
|
||||
|
||||
<item>
|
||||
<title>Bittrex</title>
|
||||
<link>https://wtfutil.com/posts/modules/cryptocurrencies/bittrex/</link>
|
||||
@ -174,10 +189,8 @@ Key: j Action: Select the next item in the list.</description>
|
||||
<description>Displays all Jira issues assigned to you for the specified project.
|
||||
Source Code wtf/jira/ Required ENV Variables Key: WTF_JIRA_API_KEY Value: Your Jira API key.
|
||||
Keyboard Commands None.
|
||||
Configuration jira:colors:rows:even:&#34;lightblue&#34;odd:&#34;white&#34;domain:&#34;https://umbrellacorp.atlassian.net&#34;email:&#34;chriscummer@me.com&#34;enabled:truejql:&#34;issueType = Story&#34;position:top:4left:1height:1width:2project:&#34;JIRA&#34;refreshInterval:900username:&#34;chris.cummer&#34; Attributes colors.rows.even Define the foreground color for even-numbered rows. Values: Any X11 color name.
|
||||
colors.rows.odd Define the foreground color for odd-numbered rows. Values: Any X11 color name.
|
||||
domain Your Jira corporate domain. Values: A valid URI.
|
||||
email The email address associated with your Jira account.</description>
|
||||
Configuration Single Jira Project jira:colors:rows:even:&#34;lightblue&#34;odd:&#34;white&#34;domain:&#34;https://umbrellacorp.atlassian.net&#34;email:&#34;chriscummer@me.com&#34;enabled:truejql:&#34;issueType = Story&#34;position:top:4left:1height:1width:2project:&#34;ProjectA&#34;refreshInterval:900username:&#34;chris.cummer&#34; Multiple Jira Projects If you want to monitor multiple Jira projects, use the following configuration (note the difference in project):
|
||||
jira:colors:rows:even:&#34;lightblue&#34;odd:&#34;white&#34;domain:&#34;https://umbrellacorp.atlassian.net&#34;email:&#34;chriscummer@me.com&#34;enabled:truejql:&#34;issueType = Story&#34;position:top:4left:1height:1width:2project:[&#34;ProjectA&#34;,&#34;ProjectB&#34;]refreshInterval:900username:&#34;chris.cummer&#34; Attributes colors.rows.even Define the foreground color for even-numbered rows. Values: Any X11 color name.</description>
|
||||
</item>
|
||||
|
||||
<item>
|
||||
@ -188,9 +201,9 @@ email The email address associated with your Jira account.</description>
|
||||
<guid>https://wtfutil.com/posts/modules/gcal/</guid>
|
||||
<description>Displays your upcoming Google calendar events.
|
||||
Not: Setting up access to Google Calendars for Go is a bit unobvious. Check out Google&rsquo;s Go Quickstart first and if you have problems, then take a look at this comment by WesleydeSouza which offers a slightly different approach.
|
||||
Source Code wtf/gcal/ Required ENV Variables Key: WTF_GOOGLE_CAL_CLIENT_ID Value: Your Google API client ID.
|
||||
Key: WTF_GOOGLE_CAL_CLIENT_SECRET Value: Your Google API client secret.
|
||||
Keyboard Commands None.</description>
|
||||
Source Code wtf/gcal/ Required ENV Variables None.
|
||||
Keyboard Commands None.
|
||||
Configuration gcal:colors:title:&#34;red&#34;description:&#34;lightblue&#34;highlights:-[&#39;1on1|1\/11&#39;,&#39;green&#39;]-[&#39;apple|google|aws&#39;,&#39;blue&#39;]-[&#39;interview|meet&#39;,&#39;magenta&#39;]-[&#39;lunch&#39;,&#39;yellow&#39;]past:&#34;gray&#34;conflictIcon:&#34;🚨&#34;currentIcon:&#34;💥&#34;displayResponseStatus:trueemail:&#34;chriscummer@me.com&#34;enabled:trueeventCount:12position:top:0left:0height:4width:1refreshInterval:300secretFile:&#34;~/.wtf/gcal/client_secret.json&#34;withLocation:true Attributes colors.title The default colour for calendar event titles. Values: Any X11 color name.</description>
|
||||
</item>
|
||||
|
||||
<item>
|
||||
|
||||
@ -124,11 +124,7 @@ first and if you have problems, then take a look at this <a href="https://github
|
||||
<div class="highlight"><pre class="chroma"><code class="language-bash" data-lang="bash">wtf/gcal/</code></pre></div>
|
||||
<h2 id="required-env-variables">Required ENV Variables</h2>
|
||||
|
||||
<p><span class="caption">Key:</span> <code>WTF_GOOGLE_CAL_CLIENT_ID</code> <br />
|
||||
<span class="caption">Value:</span> Your <a href="https://developers.google.com/calendar/auth">Google API</a> client ID.</p>
|
||||
|
||||
<p><span class="caption">Key:</span> <code>WTF_GOOGLE_CAL_CLIENT_SECRET</code> <br />
|
||||
<span class="caption">Value:</span> Your <a href="https://developers.google.com/calendar/auth">Google API</a> client secret.</p>
|
||||
<p>None.</p>
|
||||
|
||||
<h2 id="keyboard-commands">Keyboard Commands</h2>
|
||||
|
||||
|
||||
184
docs/posts/modules/gspreadsheets/index.html
Normal file
184
docs/posts/modules/gspreadsheets/index.html
Normal file
@ -0,0 +1,184 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en-us" class="wf-firasans-n4-active wf-active">
|
||||
<head>
|
||||
<link href="http://gmpg.org/xfn/11" rel="profile">
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<!-- Enable responsiveness on mobile devices -->
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
|
||||
|
||||
|
||||
<meta name="generator" content="Hugo 0.38.2" />
|
||||
|
||||
<title>Google Spreadsheets | WTF - A Terminal Dashboard</title>
|
||||
<meta content="Google Spreadsheets - WTF - A Terminal Dashboard" property="og:title">
|
||||
<meta content=" - " property="og:description">
|
||||
<!-- CSS -->
|
||||
<link rel="stylesheet" href="//cdn.rawgit.com/milligram/milligram/master/dist/milligram.min.css">
|
||||
<link href="https://fonts.googleapis.com/css?family=Fira+Sans:300,300i,400,400i|Roboto+Mono:300,300i,400,400i" rel="stylesheet">
|
||||
<link rel="stylesheet" href="https://wtfutil.com/css/print.css" media="print">
|
||||
<link rel="stylesheet" href="https://wtfutil.com/css/poole.css">
|
||||
<link rel="stylesheet" href="https://wtfutil.com/css/hyde.css">
|
||||
<link rel="stylesheet" href="https://wtfutil.com/css/syntax.css">
|
||||
<link rel="stylesheet" href="https://wtfutil.com/css/wtf.css">
|
||||
<!-- Font-Awesome -->
|
||||
<script defer src="https://use.fontawesome.com/releases/v5.0.9/js/all.js" integrity="sha384-8iPTk2s/jMVj81dnzb/iFR2sdA7u06vHJyyLlAd4snFpCl/SnyUjRrbdJsw1pGIl" crossorigin="anonymous"></script>
|
||||
|
||||
<!-- Customised CSS -->
|
||||
<link rel="stylesheet" href="https://wtfutil.com/css/custom.css">
|
||||
<!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
|
||||
<!--[if lt IE 9]>
|
||||
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
|
||||
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
|
||||
<![endif]-->
|
||||
<!-- Icons -->
|
||||
<link rel="apple-touch-icon-precomposed" sizes="144x144" href="/apple-touch-icon-144-precomposed.png">
|
||||
<link rel="shortcut icon" href="/favicon.png">
|
||||
|
||||
<script async defer src="https://buttons.github.io/buttons.js"></script>
|
||||
|
||||
</head>
|
||||
<body>
|
||||
<div class="sidebar">
|
||||
<div class="container">
|
||||
<div class="sidebar-about text-center">
|
||||
|
||||
<a href="https://wtfutil.com/"> <img src="/img/wtf.png" alt="WFT Logo" class="" width=""> </a>
|
||||
<p class="lead">
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<div>
|
||||
<h3 style="color: white;">Content</h3>
|
||||
|
||||
<ul style="list-style-type: none;">
|
||||
<li class="sidebar-list-item-1"><a href="/posts/overview/">Overview</a></li>
|
||||
<li class="sidebar-list-item-1"><a href="/posts/installation/">Installation</a></li>
|
||||
<li class="sidebar-list-item-1"><a href="/posts/configuration/">Configuration</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/configuration/attributes/">Attributes</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/configuration/iterm2/">iTerm2</a></li>
|
||||
<li class="sidebar-list-item-1"><a href="https://github.com/senorprogrammer/wtf/releases">Releases</a></li>
|
||||
</ul>
|
||||
|
||||
<ul style="list-style-type: none;">
|
||||
<li class="sidebar-list-item-1"><a href="/posts/modules/">Modules</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/bamboohr/">BambooHR</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/cryptocurrencies/bittrex/">Bittrex</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/clocks/">Clocks</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/cryptocurrencies/cryptolive/">CryptoLive</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/cmdrunner/">CmdRunner</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/git/">Git</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/github/">GitHub</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/gcal/">Google Calendar</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/ipinfo/">IPInfo</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/jira/">Jira</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/newrelic/">New Relic</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/opsgenie/">OpsGenie</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/power/">Power</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/prettyweather/">PrettyWeather</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/security/">Security</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/textfile/">Text File</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/todo/">Todo</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/weather/">Weather</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<p class="copyright">
|
||||
© 2018 Chris Cummer.
|
||||
<br />
|
||||
<a href="https://creativecommons.org/licenses/by/4.0">Some Rights Reserved</a>.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="content container">
|
||||
<div class="post">
|
||||
<h1>Google Spreadsheets</h1>
|
||||
|
||||
<div class="col-sm-12 col-md-12">
|
||||
<span class="text-left post-date meta">
|
||||
|
||||
|
||||
Jun 10, 2018
|
||||
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
</span>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<p>Added in <code>v0.0.7</code>.</p>
|
||||
|
||||
<p>Display information</p>
|
||||
<div class="highlight"><pre class="chroma"><code class="language-bash" data-lang="bash">wtf/gspreadsheets/</code></pre></div>
|
||||
<h2 id="required-env-variables">Required ENV Variables</h2>
|
||||
|
||||
<p>None.</p>
|
||||
|
||||
<h2 id="keyboard-commands">Keyboard Commands</h2>
|
||||
|
||||
<p>None.</p>
|
||||
|
||||
<h2 id="configuration">Configuration</h2>
|
||||
<div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">gspreadsheets<span class="p">:</span><span class="w">
|
||||
</span><span class="w"> </span>colors<span class="p">:</span><span class="w">
|
||||
</span><span class="w"> </span>values<span class="p">:</span><span class="w"> </span><span class="s2">"green"</span><span class="w">
|
||||
</span><span class="w"> </span>cells<span class="p">:</span><span class="w">
|
||||
</span><span class="w"> </span>names<span class="p">:</span><span class="w">
|
||||
</span><span class="w"> </span>-<span class="w"> </span><span class="s2">"Cell 1 name"</span><span class="w">
|
||||
</span><span class="w"> </span>-<span class="w"> </span><span class="s2">"Cell 2 name"</span><span class="w">
|
||||
</span><span class="w"> </span>addresses<span class="p">:</span><span class="w">
|
||||
</span><span class="w"> </span>-<span class="w"> </span><span class="s2">"A1"</span><span class="w">
|
||||
</span><span class="w"> </span>-<span class="w"> </span><span class="s2">"A2"</span><span class="w">
|
||||
</span><span class="w"> </span>enabled<span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
||||
</span><span class="w"> </span>position<span class="p">:</span><span class="w">
|
||||
</span><span class="w"> </span>top<span class="p">:</span><span class="w"> </span><span class="m">0</span><span class="w">
|
||||
</span><span class="w"> </span>left<span class="p">:</span><span class="w"> </span><span class="m">0</span><span class="w">
|
||||
</span><span class="w"> </span>width<span class="p">:</span><span class="w"> </span><span class="m">1</span><span class="w">
|
||||
</span><span class="w"> </span>height<span class="p">:</span><span class="w"> </span><span class="m">1</span><span class="w">
|
||||
</span><span class="w"> </span>refreshInterval<span class="p">:</span><span class="w"> </span><span class="s2">"300"</span><span class="w">
|
||||
</span><span class="w"> </span>secretFile<span class="p">:</span><span class="w"> </span><span class="s2">"~/.wtf/gspreadsheets/client_secret.json"</span><span class="w">
|
||||
</span><span class="w"> </span>sheetId<span class="p">:</span><span class="w"> </span><span class="s2">"id_of_google_spreadsheet"</span></code></pre></div>
|
||||
<h3 id="attributes">Attributes</h3>
|
||||
|
||||
<p><code>colors.values</code> <br />
|
||||
The color to display the cell values in. <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11 color</a> name.</p>
|
||||
|
||||
<p><code>cells.names</code> <br /></p>
|
||||
|
||||
<p><code>cells.addresses</code> <br /></p>
|
||||
|
||||
<p><code>enabled</code> <br />
|
||||
Whether or not this module is executed and if its data displayed onscreen. <br />
|
||||
Values: <code>true</code>, <code>false</code>.</p>
|
||||
|
||||
<p><code>position</code> <br />
|
||||
Where in the grid this module’s widget will be displayed. <br /></p>
|
||||
|
||||
<p><code>refreshInterval</code> <br />
|
||||
How often, in seconds, this module will update its data. <br />
|
||||
Values: A positive integer, <code>0..n</code>.</p>
|
||||
|
||||
<p><code>secretFile</code> <br />
|
||||
Your <a href="https://developers.google.com/sheets/api/quickstart/go">Google client secret</a> JSON file. <br />
|
||||
Values: A string representing a file path to the JSON secret file.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="footer">
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -129,6 +129,8 @@
|
||||
<p>None.</p>
|
||||
|
||||
<h2 id="configuration">Configuration</h2>
|
||||
|
||||
<h3 id="single-jira-project">Single Jira Project</h3>
|
||||
<div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">jira<span class="p">:</span><span class="w">
|
||||
</span><span class="w"> </span>colors<span class="p">:</span><span class="w">
|
||||
</span><span class="w"> </span>rows<span class="p">:</span><span class="w">
|
||||
@ -143,7 +145,28 @@
|
||||
</span><span class="w"> </span>left<span class="p">:</span><span class="w"> </span><span class="m">1</span><span class="w">
|
||||
</span><span class="w"> </span>height<span class="p">:</span><span class="w"> </span><span class="m">1</span><span class="w">
|
||||
</span><span class="w"> </span>width<span class="p">:</span><span class="w"> </span><span class="m">2</span><span class="w">
|
||||
</span><span class="w"> </span>project<span class="p">:</span><span class="w"> </span><span class="s2">"JIRA"</span><span class="w">
|
||||
</span><span class="w"> </span>project<span class="p">:</span><span class="w"> </span><span class="s2">"ProjectA"</span><span class="w">
|
||||
</span><span class="w"> </span>refreshInterval<span class="p">:</span><span class="w"> </span><span class="m">900</span><span class="w">
|
||||
</span><span class="w"> </span>username<span class="p">:</span><span class="w"> </span><span class="s2">"chris.cummer"</span></code></pre></div>
|
||||
<h3 id="multiple-jira-projects">Multiple Jira Projects</h3>
|
||||
|
||||
<p>If you want to monitor multiple Jira projects, use the following
|
||||
configuration (note the difference in <code>project</code>):</p>
|
||||
<div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">jira<span class="p">:</span><span class="w">
|
||||
</span><span class="w"> </span>colors<span class="p">:</span><span class="w">
|
||||
</span><span class="w"> </span>rows<span class="p">:</span><span class="w">
|
||||
</span><span class="w"> </span>even<span class="p">:</span><span class="w"> </span><span class="s2">"lightblue"</span><span class="w">
|
||||
</span><span class="w"> </span>odd<span class="p">:</span><span class="w"> </span><span class="s2">"white"</span><span class="w">
|
||||
</span><span class="w"> </span>domain<span class="p">:</span><span class="w"> </span><span class="s2">"https://umbrellacorp.atlassian.net"</span><span class="w">
|
||||
</span><span class="w"> </span>email<span class="p">:</span><span class="w"> </span><span class="s2">"chriscummer@me.com"</span><span class="w">
|
||||
</span><span class="w"> </span>enabled<span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
||||
</span><span class="w"> </span>jql<span class="p">:</span><span class="w"> </span><span class="s2">"issueType = Story"</span><span class="w">
|
||||
</span><span class="w"> </span>position<span class="p">:</span><span class="w">
|
||||
</span><span class="w"> </span>top<span class="p">:</span><span class="w"> </span><span class="m">4</span><span class="w">
|
||||
</span><span class="w"> </span>left<span class="p">:</span><span class="w"> </span><span class="m">1</span><span class="w">
|
||||
</span><span class="w"> </span>height<span class="p">:</span><span class="w"> </span><span class="m">1</span><span class="w">
|
||||
</span><span class="w"> </span>width<span class="p">:</span><span class="w"> </span><span class="m">2</span><span class="w">
|
||||
</span><span class="w"> </span>project<span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">"ProjectA"</span><span class="p">,</span><span class="w"> </span><span class="s2">"ProjectB"</span><span class="p">]</span><span class="w">
|
||||
</span><span class="w"> </span>refreshInterval<span class="p">:</span><span class="w"> </span><span class="m">900</span><span class="w">
|
||||
</span><span class="w"> </span>username<span class="p">:</span><span class="w"> </span><span class="s2">"chris.cummer"</span></code></pre></div>
|
||||
<h3 id="attributes">Attributes</h3>
|
||||
|
||||
@ -2,6 +2,11 @@
|
||||
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"
|
||||
xmlns:xhtml="http://www.w3.org/1999/xhtml">
|
||||
|
||||
<url>
|
||||
<loc>https://wtfutil.com/posts/modules/gspreadsheets/</loc>
|
||||
<lastmod>2018-06-10T18:26:26-04:00</lastmod>
|
||||
</url>
|
||||
|
||||
<url>
|
||||
<loc>https://wtfutil.com/posts/modules/cryptocurrencies/bittrex/</loc>
|
||||
<lastmod>2018-06-04T20:06:40-07:00</lastmod>
|
||||
@ -134,7 +139,7 @@
|
||||
|
||||
<url>
|
||||
<loc>https://wtfutil.com/posts/</loc>
|
||||
<lastmod>2018-06-04T20:06:40-07:00</lastmod>
|
||||
<lastmod>2018-06-10T18:26:26-04:00</lastmod>
|
||||
<priority>0</priority>
|
||||
</url>
|
||||
|
||||
@ -145,7 +150,7 @@
|
||||
|
||||
<url>
|
||||
<loc>https://wtfutil.com/</loc>
|
||||
<lastmod>2018-06-04T20:06:40-07:00</lastmod>
|
||||
<lastmod>2018-06-10T18:26:26-04:00</lastmod>
|
||||
<priority>0</priority>
|
||||
</url>
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user