README - Metrics — ContextQMD

<table> <tr><td colspan="2"><a href="/README.md#-plugins">← Back to plugins index</a></td></tr> <tr><th colspan="2"><h3>🐤 Latest tweets</h3></th></tr> <tr><td colspan="2" align="center"><p>This plugin displays the latest tweets from a <a href="https://twitter.com">Twitter</a> account.</p> </td></tr> <tr><th>⚠️ Deprecated</th><td><p>As <a href="https://twitter.com">Twitter</a> removed the ability to fetch tweets from their free API as part of their new <a href="https://developer.twitter.com/en/docs/twitter-api/getting-started/about-twitter-api">pricing policy</a>, this plugin is no longer maintained.</p> </td></tr> <tr><th>⚠️ Disclaimer</th><td><p>This plugin is not affiliated, associated, authorized, endorsed by, or in any way officially connected with <a href="https://twitter.com">Twitter</a>. All product and company names are trademarks™ or registered® trademarks of their respective holders.</p> </td></tr> <tr> <th rowspan="3">Supported features <sub><a href="metadata.yml">→ Full specification</a></sub></th> <td><a href="/source/templates/classic/README.md"><code>📗 Classic template</code></a> <a href="/source/templates/markdown/README.md"><code>📒 Markdown template</code></a></td> </tr> <tr> <td><code>👤 Users</code> <code>👥 Organizations</code></td> </tr> <tr> <td><code>🗝️ plugin_tweets_token</code></td> </tr> <tr> <td colspan="2" align="center"> <details open><summary>Latest tweets with attachments</summary></img></details> <details><summary>Latest tweets</summary></img></details>

</td>

</tr> </table>

➡️ Available options

<table> <tr> <td align="center" nowrap="nowrap">Option</i></td><td align="center" nowrap="nowrap">Description</td> </tr> <tr> <td nowrap="nowrap"><h4><code>plugin_tweets</code></h4></td> <td rowspan="2"><p>Enable tweets plugin</p> </td> </tr> <tr> <td nowrap="nowrap">🌐 Web instances must configure <code>settings.json</code>: <ul> <li><i>metrics.api.twitter.tweets</i></li> </ul> <b>type:</b> <code>boolean</code>

<b>default:</b> no

</td> </tr> <tr> <td nowrap="nowrap"><h4><code>plugin_tweets_token</code></h4></td> <td rowspan="2"><p>Twitter API token</p> </td> </tr> <tr> <td nowrap="nowrap">🔐 Token

<b>type:</b> <code>token</code>

</td> </tr> <tr> <td nowrap="nowrap"><h4><code>plugin_tweets_user</code></h4></td> <td rowspan="2"><p>Twitter username</p> </td> </tr> <tr> <td nowrap="nowrap">⏯️ Cannot be preset

<b>type:</b> <code>string</code>

<b>default:</b> <code>→ User attached twitter</code>

</td> </tr> <tr> <td nowrap="nowrap"><h4><code>plugin_tweets_attachments</code></h4></td> <td rowspan="2"><p>Tweets attachments</p> <p>Can be used to display linked images, video thumbnails, etc.</p> </td> </tr> <tr> <td nowrap="nowrap"><b>type:</b> <code>boolean</code>

<b>default:</b> no

</td> </tr> <tr> <td nowrap="nowrap"><h4><code>plugin_tweets_limit</code></h4></td> <td rowspan="2"><p>Display limit</p> </td> </tr> <tr> <td nowrap="nowrap"><b>type:</b> <code>number</code> <i>(1 ≤ 𝑥 ≤ 10)</i>

<b>default:</b> 2

</td> </tr> </table>

🗝️ Obtaining a Twitter token

To get a Twitter token, it is required to apply to the developer program. It's a bit tedious, but requests seems to be approved quite quickly.

Create an app from the developer dashboard and register your bearer token in repository secrets.

ℹ️ Examples workflows

yaml

name: Latest tweets
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.tweets.svg
  token: NOT_NEEDED
  base: ""
  plugin_tweets: yes
  plugin_tweets_token: ${{ secrets.TWITTER_TOKEN }}
  plugin_tweets_user: github

yaml

name: Latest tweets including attachments
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.tweets.attachments.svg
  token: NOT_NEEDED
  base: ""
  plugin_tweets: yes
  plugin_tweets_token: ${{ secrets.TWITTER_TOKEN }}
  plugin_tweets_attachments: yes
  plugin_tweets_user: github
  plugin_tweets_limit: 1