Skip to content

OptimumMeans/TRMNL-FBI-Most-Wanted

Repository files navigation

FBI Wanted TRMNL Plugin

A TRMNL plugin that displays FBI's Most Wanted list using the official FBI Wanted API.

Features

  • Displays current FBI Most Wanted list
  • Shows detailed information for each wanted person
  • Auto-updates every 6 hours via GitHub Actions
  • Includes warning messages and reward information when available
  • Clean, organized display using TRMNL's design system

Setup

  1. Create a new Private Plugin in TRMNL:

    • Go to Plugins -> Private Plugin -> Add New
    • Name it "FBI Most Wanted"
    • Select "Webhook" for the Strategy
    • Save and copy the Plugin UUID
  2. Configure the plugin:

    • Copy .env.example to .env
    • Add your TRMNL Plugin UUID to .env
    • Copy the markup from markup.html into TRMNL's plugin markup editor
  3. Set up GitHub Actions:

    • Add your TRMNL Plugin UUID as a GitHub secret named TRMNL_PLUGIN_UUID
    • The workflow will automatically run every 6 hours

Local Development

  1. Install dependencies:
pip install -r requirements.txt
  1. Create .env file with your configuration:
cp .env.example .env
  1. Edit .env with your TRMNL Plugin UUID

  2. Run the script:

python main.py

GitHub Actions Configuration

The plugin automatically updates every 6 hours using GitHub Actions. You can also trigger updates manually from the Actions tab in your repository.

License

MIT License

Acknowledgments

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors