1
0
mirror of https://github.com/taigrr/wtf synced 2025-01-18 04:03:14 -08:00

Update Twitter documentation

This commit is contained in:
Chris Cummer 2018-08-17 14:44:28 -07:00
parent eb4f995e80
commit 3681bea0a8
10 changed files with 124 additions and 36 deletions

View File

@ -11,8 +11,13 @@ Connects to the Twitter API and displays a single user's tweets.
NOTE: This only works for single-application developer accounts for now. NOTE: This only works for single-application developer accounts for now.
To get your bearer token, please see: To make this work, you'll need a couple of things:
https://github.com/Trinergy/twitter_bearer_token
1. A [Twitter developer account](https://developer.twitter.com/content/developer-twitter/en.html)
2. A [Twitter bearer token](https://developer.twitter.com/en/docs/basics/authentication/overview/application-only).
Once you have your developer account, a relatively painless way to get a
bearer token is to use [TBT](https://github.com/Trinergy/twitter_bearer_token).
## Source Code ## Source Code

View File

@ -277,7 +277,7 @@
"title": "Twitter", "title": "Twitter",
"tags": [], "tags": [],
"description": "", "description": "",
"content": " Added in v0.2.0.\nConnects to the Twitter API and displays a single user\u0026rsquo;s tweets.\nNOTE: This only works for single-application developer accounts for now.\nSource Code wtf/twitter/ Configuration twitter:bearerToken:\u0026#34;3276d7155dd9ee27b8b14f8743a408a9\u0026#34;enabled:trueposition:top:0left:1height:1width:1refreshInterval:20000 Attributes bearerToken Value: Your Twitter single-application Bearer Token\nenabled Whether or not this module is executed and if its data displayed onscreen. Values: true, false.\nposition Defines where in the grid this module\u0026rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. Values: Any positive integer, 0..n.\n" "content": " Added in v0.2.0.\nConnects to the Twitter API and displays a single user\u0026rsquo;s tweets.\nNOTE: This only works for single-application developer accounts for now.\nTo get your bearer token, please see: https://github.com/Trinergy/twitter_bearer_token\nSource Code wtf/twitter/ Configuration twitter:bearerToken:\u0026#34;3276d7155dd9ee27b8b14f8743a408a9\u0026#34;enabled:trueposition:top:0left:1height:1width:1refreshInterval:20000 Attributes bearerToken Value: Your Twitter single-application Bearer Token\nenabled Whether or not this module is executed and if its data displayed onscreen. Values: true, false.\nposition Defines where in the grid this module\u0026rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. Values: Any positive integer, 0..n.\n"
}, },
{ {
"uri": "https://wtfutil.com/modules/weather_services/", "uri": "https://wtfutil.com/modules/weather_services/",

View File

@ -475,9 +475,10 @@ board The name of the Trello board. enabled Determines whether or not this modul
<description>Added in v0.2.0. <description>Added in v0.2.0.
Connects to the Twitter API and displays a single user&amp;rsquo;s tweets. Connects to the Twitter API and displays a single user&amp;rsquo;s tweets.
NOTE: This only works for single-application developer accounts for now. NOTE: This only works for single-application developer accounts for now.
To get your bearer token, please see: https://github.com/Trinergy/twitter_bearer_token
Source Code wtf/twitter/ Configuration twitter:bearerToken:&amp;#34;3276d7155dd9ee27b8b14f8743a408a9&amp;#34;enabled:trueposition:top:0left:1height:1width:1refreshInterval:20000 Attributes bearerToken Value: Your Twitter single-application Bearer Token Source Code wtf/twitter/ Configuration twitter:bearerToken:&amp;#34;3276d7155dd9ee27b8b14f8743a408a9&amp;#34;enabled:trueposition:top:0left:1height:1width:1refreshInterval:20000 Attributes bearerToken Value: Your Twitter single-application Bearer Token
enabled Whether or not this module is executed and if its data displayed onscreen. Values: true, false. enabled Whether or not this module is executed and if its data displayed onscreen. Values: true, false.
position Defines where in the grid this module&amp;rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data.</description> position Defines where in the grid this module&amp;rsquo;s widget will be displayed.</description>
</item> </item>
<item> <item>

View File

@ -141,6 +141,36 @@
CmdRunner CmdRunner
</a><i class="fa fa-circle-thin read-icon"></i> </a><i class="fa fa-circle-thin read-icon"></i>
</div> </div>
</li>
<li data-nav-id="/modules/cryptocurrencies/" class="dd-item parent haschildren
">
<div>
<a href="/modules/cryptocurrencies/">Crypo Currencies</a>
<i class="fa fa-angle-down fa-lg category-icon"></i><i class="fa fa-circle-thin read-icon"></i>
</div>
<ul>
<li data-nav-id="/modules/cryptocurrencies/bittrex/" class="dd-item active">
<div>
<a href="/modules/cryptocurrencies/bittrex/">
Bittrex
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/cryptocurrencies/blockfolio/" class="dd-item">
<div>
<a href="/modules/cryptocurrencies/blockfolio/">
Blockfolio
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/cryptocurrencies/cryptolive/" class="dd-item">
<div>
<a href="/modules/cryptocurrencies/cryptolive/">
CryptoLive
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
</ul>
</li> </li>
<li data-nav-id="/modules/gerrit/" class="dd-item"> <li data-nav-id="/modules/gerrit/" class="dd-item">
<div> <div>
@ -176,6 +206,28 @@
Gitter Gitter
</a><i class="fa fa-circle-thin read-icon"></i> </a><i class="fa fa-circle-thin read-icon"></i>
</div> </div>
</li>
<li data-nav-id="/modules/google/" class="dd-item haschildren
">
<div>
<a href="/modules/google/">Google Apps</a><i class="fa fa-angle-right fa-lg category-icon"></i><i class="fa fa-circle-thin read-icon"></i>
</div>
<ul>
<li data-nav-id="/modules/google/gcal/" class="dd-item">
<div>
<a href="/modules/google/gcal/">
Google Calendar
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/google/gspreadsheet/" class="dd-item">
<div>
<a href="/modules/google/gspreadsheet/">
Google Spreadsheets
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
</ul>
</li> </li>
<li data-nav-id="/modules/hackernews/" class="dd-item"> <li data-nav-id="/modules/hackernews/" class="dd-item">
<div> <div>
@ -183,6 +235,28 @@
Hacker News Hacker News
</a><i class="fa fa-circle-thin read-icon"></i> </a><i class="fa fa-circle-thin read-icon"></i>
</div> </div>
</li>
<li data-nav-id="/modules/ipaddress/" class="dd-item haschildren
">
<div>
<a href="/modules/ipaddress/">IP Addresses</a><i class="fa fa-angle-right fa-lg category-icon"></i><i class="fa fa-circle-thin read-icon"></i>
</div>
<ul>
<li data-nav-id="/modules/ipaddress/ipapi/" class="dd-item">
<div>
<a href="/modules/ipaddress/ipapi/">
IP-API
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/ipaddress/ipinfo/" class="dd-item">
<div>
<a href="/modules/ipaddress/ipinfo/">
IPInfo
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
</ul>
</li> </li>
<li data-nav-id="/modules/jenkins/" class="dd-item"> <li data-nav-id="/modules/jenkins/" class="dd-item">
<div> <div>
@ -274,6 +348,28 @@
Twitter Twitter
</a><i class="fa fa-circle-thin read-icon"></i> </a><i class="fa fa-circle-thin read-icon"></i>
</div> </div>
</li>
<li data-nav-id="/modules/weather_services/" class="dd-item haschildren
">
<div>
<a href="/modules/weather_services/">Weather Services</a><i class="fa fa-angle-right fa-lg category-icon"></i><i class="fa fa-circle-thin read-icon"></i>
</div>
<ul>
<li data-nav-id="/modules/weather_services/prettyweather/" class="dd-item">
<div>
<a href="/modules/weather_services/prettyweather/">
Pretty Weather
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/weather_services/weather/" class="dd-item">
<div>
<a href="/modules/weather_services/weather/">
Weather
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
</ul>
</li> </li>
<li data-nav-id="/modules/zendesk/" class="dd-item"> <li data-nav-id="/modules/zendesk/" class="dd-item">
<div> <div>

View File

@ -404,24 +404,12 @@
<option value="/modules/circleci/" >- CircleCI</option> <option value="/modules/circleci/" >- CircleCI</option>
<option value="/modules/clocks/" >- Clocks</option> <option value="/modules/clocks/" >- Clocks</option>
<option value="/modules/cmdrunner/" >- CmdRunner</option> <option value="/modules/cmdrunner/" >- CmdRunner</option>
<option value="/modules/cryptocurrencies/" >
-
Crypo Currencies</option>
<option value="/modules/gerrit/" >- Gerrit</option> <option value="/modules/gerrit/" >- Gerrit</option>
<option value="/modules/git/" >- Git</option> <option value="/modules/git/" >- Git</option>
<option value="/modules/github/" >- GitHub</option> <option value="/modules/github/" >- GitHub</option>
<option value="/modules/gitlab/" >- GitLab</option> <option value="/modules/gitlab/" >- GitLab</option>
<option value="/modules/gitter/" >- Gitter</option> <option value="/modules/gitter/" >- Gitter</option>
<option value="/modules/google/" >
-
Google Apps</option>
<option value="/modules/google/gcal/" selected>-- Google Calendar</option>
<option value="/modules/google/gspreadsheet/" >-- Google Spreadsheets</option>
<option value="/modules/hackernews/" >- Hacker News</option> <option value="/modules/hackernews/" >- Hacker News</option>
<option value="/modules/ipaddress/" >
-
IP Addresses</option>
<option value="/modules/jenkins/" >- Jenkins</option> <option value="/modules/jenkins/" >- Jenkins</option>
<option value="/modules/jira/" >- Jira</option> <option value="/modules/jira/" >- Jira</option>
<option value="/modules/logger/" >- Logger</option> <option value="/modules/logger/" >- Logger</option>
@ -435,9 +423,6 @@
<option value="/modules/travisci/" >- TravisCI</option> <option value="/modules/travisci/" >- TravisCI</option>
<option value="/modules/trello/" >- Trello</option> <option value="/modules/trello/" >- Trello</option>
<option value="/modules/twitter/" >- Twitter</option> <option value="/modules/twitter/" >- Twitter</option>
<option value="/modules/weather_services/" >
-
Weather Services</option>
<option value="/modules/zendesk/" >- Zendesk</option> <option value="/modules/zendesk/" >- Zendesk</option>

View File

@ -325,9 +325,10 @@ board The name of the Trello board. enabled Determines whether or not this modul
<description>Added in v0.2.0. <description>Added in v0.2.0.
Connects to the Twitter API and displays a single user&amp;rsquo;s tweets. Connects to the Twitter API and displays a single user&amp;rsquo;s tweets.
NOTE: This only works for single-application developer accounts for now. NOTE: This only works for single-application developer accounts for now.
To get your bearer token, please see: https://github.com/Trinergy/twitter_bearer_token
Source Code wtf/twitter/ Configuration twitter:bearerToken:&amp;#34;3276d7155dd9ee27b8b14f8743a408a9&amp;#34;enabled:trueposition:top:0left:1height:1width:1refreshInterval:20000 Attributes bearerToken Value: Your Twitter single-application Bearer Token Source Code wtf/twitter/ Configuration twitter:bearerToken:&amp;#34;3276d7155dd9ee27b8b14f8743a408a9&amp;#34;enabled:trueposition:top:0left:1height:1width:1refreshInterval:20000 Attributes bearerToken Value: Your Twitter single-application Bearer Token
enabled Whether or not this module is executed and if its data displayed onscreen. Values: true, false. enabled Whether or not this module is executed and if its data displayed onscreen. Values: true, false.
position Defines where in the grid this module&amp;rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data.</description> position Defines where in the grid this module&amp;rsquo;s widget will be displayed.</description>
</item> </item>
<item> <item>

View File

@ -404,24 +404,12 @@
<option value="/modules/circleci/" >- CircleCI</option> <option value="/modules/circleci/" >- CircleCI</option>
<option value="/modules/clocks/" >- Clocks</option> <option value="/modules/clocks/" >- Clocks</option>
<option value="/modules/cmdrunner/" >- CmdRunner</option> <option value="/modules/cmdrunner/" >- CmdRunner</option>
<option value="/modules/cryptocurrencies/" >
-
Crypo Currencies</option>
<option value="/modules/gerrit/" >- Gerrit</option> <option value="/modules/gerrit/" >- Gerrit</option>
<option value="/modules/git/" >- Git</option> <option value="/modules/git/" >- Git</option>
<option value="/modules/github/" >- GitHub</option> <option value="/modules/github/" >- GitHub</option>
<option value="/modules/gitlab/" >- GitLab</option> <option value="/modules/gitlab/" >- GitLab</option>
<option value="/modules/gitter/" >- Gitter</option> <option value="/modules/gitter/" >- Gitter</option>
<option value="/modules/google/" >
-
Google Apps</option>
<option value="/modules/hackernews/" >- Hacker News</option> <option value="/modules/hackernews/" >- Hacker News</option>
<option value="/modules/ipaddress/" >
-
IP Addresses</option>
<option value="/modules/ipaddress/ipapi/" selected>-- IP-API</option>
<option value="/modules/ipaddress/ipinfo/" >-- IPInfo</option>
<option value="/modules/jenkins/" >- Jenkins</option> <option value="/modules/jenkins/" >- Jenkins</option>
<option value="/modules/jira/" >- Jira</option> <option value="/modules/jira/" >- Jira</option>
<option value="/modules/logger/" >- Logger</option> <option value="/modules/logger/" >- Logger</option>
@ -435,9 +423,6 @@
<option value="/modules/travisci/" >- TravisCI</option> <option value="/modules/travisci/" >- TravisCI</option>
<option value="/modules/trello/" >- Trello</option> <option value="/modules/trello/" >- Trello</option>
<option value="/modules/twitter/" >- Twitter</option> <option value="/modules/twitter/" >- Twitter</option>
<option value="/modules/weather_services/" >
-
Weather Services</option>
<option value="/modules/zendesk/" >- Zendesk</option> <option value="/modules/zendesk/" >- Zendesk</option>

View File

@ -403,12 +403,21 @@
<option value="/modules/circleci/" >- CircleCI</option> <option value="/modules/circleci/" >- CircleCI</option>
<option value="/modules/clocks/" >- Clocks</option> <option value="/modules/clocks/" >- Clocks</option>
<option value="/modules/cmdrunner/" >- CmdRunner</option> <option value="/modules/cmdrunner/" >- CmdRunner</option>
<option value="/modules/cryptocurrencies/" >
-
Crypo Currencies</option>
<option value="/modules/gerrit/" >- Gerrit</option> <option value="/modules/gerrit/" >- Gerrit</option>
<option value="/modules/git/" >- Git</option> <option value="/modules/git/" >- Git</option>
<option value="/modules/github/" >- GitHub</option> <option value="/modules/github/" >- GitHub</option>
<option value="/modules/gitlab/" >- GitLab</option> <option value="/modules/gitlab/" >- GitLab</option>
<option value="/modules/gitter/" >- Gitter</option> <option value="/modules/gitter/" >- Gitter</option>
<option value="/modules/google/" >
-
Google Apps</option>
<option value="/modules/hackernews/" >- Hacker News</option> <option value="/modules/hackernews/" >- Hacker News</option>
<option value="/modules/ipaddress/" >
-
IP Addresses</option>
<option value="/modules/jenkins/" selected>- Jenkins</option> <option value="/modules/jenkins/" selected>- Jenkins</option>
<option value="/modules/jira/" >- Jira</option> <option value="/modules/jira/" >- Jira</option>
<option value="/modules/logger/" >- Logger</option> <option value="/modules/logger/" >- Logger</option>
@ -422,6 +431,9 @@
<option value="/modules/travisci/" >- TravisCI</option> <option value="/modules/travisci/" >- TravisCI</option>
<option value="/modules/trello/" >- Trello</option> <option value="/modules/trello/" >- Trello</option>
<option value="/modules/twitter/" >- Twitter</option> <option value="/modules/twitter/" >- Twitter</option>
<option value="/modules/weather_services/" >
-
Weather Services</option>
<option value="/modules/zendesk/" >- Zendesk</option> <option value="/modules/zendesk/" >- Zendesk</option>

View File

@ -470,6 +470,9 @@
<p>NOTE: This only works for single-application developer accounts for now.</p> <p>NOTE: This only works for single-application developer accounts for now.</p>
<p>To get your bearer token, please see:
<a href="https://github.com/Trinergy/twitter_bearer_token">https://github.com/Trinergy/twitter_bearer_token</a></p>
<h2 id="source-code">Source Code</h2> <h2 id="source-code">Source Code</h2>
<div class="highlight"><pre class="chroma"><code class="language-bash" data-lang="bash">wtf/twitter/</code></pre></div> <div class="highlight"><pre class="chroma"><code class="language-bash" data-lang="bash">wtf/twitter/</code></pre></div>
<h2 id="configuration">Configuration</h2> <h2 id="configuration">Configuration</h2>

View File

@ -25,7 +25,7 @@ type Client struct {
func NewClient(url string) *Client { func NewClient(url string) *Client {
client := Client{ client := Client{
apiBase: url, apiBase: url,
screenName: "wtfutil", screenName: "senorprogrammer",
count: 5, count: 5,
} }