Skip to content

tomkins/wagtail-nestbox

Repository files navigation

Wagtail Nest Box

A Raspberry Pi project to show GitHub stats for Wagtail.

Why?

After attending Wagtail Space NL 2024, speakers were given a bird nest box as a thank you gift. To keep it as a more permanent memento, I decided to come up with an alternative use for it - showing Wagtail stats pulled from GitHub!

Nest box with lanyard Nest box with display attached

It's currently set to show any repository from the Wagtail organisation that has had any commits in the past 30 days. Number of open issues, open pull requests, and stars are shown, along with the latest commit and commit message.

A huge thank you to Four Digits for the gift, and for running such a fantastic event!

Setup

Currently running on:

Should work with any Debian bookworm versions of Raspberry Pi OS, although only the 64-bit version has been tested.

Installation

Quick install

Not recommended for security reasons, but it's the fastest way.

Generate a GitHub personal access token, then run the following on the Pi over SSH:

$ sudo -i
# bash <(curl -s https://raw.githubusercontent.com/tomkins/wagtail-nestbox/main/setup.sh)

Manual install

Follow instructions in setup.sh.

Not distributed on PyPI as this is a personal project.

Licensing

Code for this project is provided under the 3-Clause BSD License.

Icons used in this project are from Primer Octicons, available under the MIT License.