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>💩 PoopMap plugin</h3></th></tr> <tr><td colspan="2" align="center"><p>This plugin displays statistics from a <a href="https://poopmap.net">PoopMap</a> account.</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://poopmap.net">PoopMap</a>. All product and company names are trademarks™ or registered® trademarks of their respective holders.</p> </td></tr> <tr><th>Authors</th><td><a href="https://github.com/matievisthekat">@matievisthekat</a></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></td> </tr> <tr> <td><code>👤 Users</code></td> </tr> <tr> <td><code>🗝️ plugin_poopmap_token</code></td> </tr> <tr> <td colspan="2" align="center"> </img>

</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_poopmap</code></h4></td> <td rowspan="2"><p>Enable poopmap plugin</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_poopmap_token</code></h4></td> <td rowspan="2"><p>PoopMap 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_poopmap_days</code></h4></td> <td rowspan="2"><p>Time range</p> </td> </tr> <tr> <td nowrap="nowrap"><b>type:</b> <code>number</code>

<b>default:</b> 7

<b>allowed values:</b><ul><li>7</li><li>30</li><li>180</li><li>365</li></ul></td>

</tr> </table>

🗝️ Obtaining a PoopMap token

Install PoopMap app (iOS/Android) and create an account.

Navigate to your profile in the app

Tap "Share Profile" in the top right

Tap "Copy to Clipboard"

It should result in something like Haha, check out the places I've pooped on Poop Map https://api.poopmap.net/map?token=xxxxxxxxxx copied.

Extract the token query parameter from the link and use it in plugin_poopmap_token. This token will not expire and it will be able to access only public details.

ℹ️ Examples workflows

yaml

uses: lowlighter/metrics@latest
with:
  token: NOT_NEEDED
  plugin_poopmap_token: ${{ secrets.POOPMAP_TOKEN }}
  plugin_poopmap: yes