Bring! shopping list TRMNL plugin

Unofficial Bring! plugin for TRMNL

How to use

1. Create a private plugin on TRMNL dashboard

First, create a private plugin with webhook strategy.

You then need to create the view templates for your plugin. Go to the Edit Markup page:

paste the contents of full-height.liquid into the Full and and Half Vertical tabs.
paste the contents of half-height.liquid into the Half Horizontal and and Quadrant tabs.

2. Run the backend service

The backend service runs indefinitely, queries Bring! every 15 minutes to grab the list of items in your shopping list and sends the list to TRMNL if the shopping list changed since the last query.

Have these handy:

Bring! account email
Bring! account password
TRMNL plugin webhook URL. You can find this at the bottom of your private plugin page.

Note: If you signed up to Bring! using Apple ID or Google Sign-in or other SSOs you need to create password first. More here.

You can either run the backend service through docker or run the script directly.

Docker

Pull the docker image and pass the email, password and webhook url as env variables.

docker pull ghcr.io/yshrdbrn/trmnl-bring-plugin:main

docker run
    -d
    --name='BringTRMNLPlugin'
    -e 'EMAIL'='<email>'
    -e 'PASSWORD'='<password>'
    -e 'WEBHOOK_URL'='<url>'
    'ghcr.io/yshrdbrn/trmnl-bring-plugin:main'

Run the script directly

Clone the repo and rename .env.example to .env and put in your email, password and webhook url there. Then run the script:

python3 -m venv venv
pip install -r requirements.txt
python ./main.py

2.1 KiB Raw Blame History