Skip to main content

A GNOME-native worship service planning tool for United Church of Canada ministry

Project description

Rubric

Tests

A GNOME-native worship service planning tool for United Church of Canada ministry.

Rubric integrates the Revised Common Lectionary, hymn lookup for Voices United, More Voices, and Let Us Sing, Bible passage retrieval, and export options for bulletin production.


Features

  • Simple mode (on by default) — keeps the interface focused for everyday planning. Toggle with the SIMPLE button in the status bar or in Preferences → View.
  • GOST Type B font — toggle the engineering-style monoline font globally with the GOST button in the status bar
  • Focus mode — hide the palette and element list for distraction-free editing (Focus button in the status bar)
  • Observance chips — feast days and commemorations appear in the centre of the status bar as clickable chips; click any to open a Wikipedia article window
  • Git push — commit and push the current service to GitHub with the Git button in the status bar
  • RCL integration — lectionary readings, liturgical colour, and season for any Sunday; weekday services default to the coming Sunday with a stepper
  • Lectionary year tracker — persistent Year A/B/C and season indicator in the header, updated daily
  • Hymn suggestions — season and Proper-specific suggestions (Propers 4–29) from VU, MV, and LUS; left-click to view on Hymnary.org, right-click to inject into the selected element
  • Hymn lookup — type VU 16 or MV 120 to fetch the title from Hymnary.org; inline Hymnary preview with WebKit (bundled)
  • Bible viewer — fetch passages in WEB, KJV, ASV, or ESV (ESV requires a free API key from api.esv.org)
  • HTML export — generates a clean, print-ready HTML file and opens it in the browser
  • Bulletin PDF export — compiled with the bundled Typst typesetter; no LaTeX required
    • Print (booklet) — half-letter (5.5 × 8.5 in), fold for saddle-stitch
    • Digital (screen PDF) — full letter, colour hyperlinks
  • Rich text editor — per-element formatting toolbar (bold, italic, headings, lists, leader notes) with a Typst toggle for raw source editing; both modes store the same Typst content
  • Live PDF preview — bulletin compiles in the background as you edit
  • Per-element bulletin toggle — marks each element shown or hidden in the bulletin independently of the leader copy
  • Bulletin preferences — church name, address, service time, website, email, phone, welcome line, accessibility note, mission statement, staff/contact list, and announcements — all in Preferences → Bulletin
  • Announcement expiry — each announcement carries an optional YYYY-MM-DD expiry date; expired announcements are omitted automatically
  • Past Liturgies archive — browse every saved service in a read-only viewer; insert any past element's text into the current service with one click
  • Element Library — searchable database of every element from every saved service
  • Bulletin preview panel — live preview of the congregational bulletin as you edit; popout to a floating window
  • Service Planner — scans the liturgy/ folder and lists all services grouped into Upcoming and Past
  • GitHub repository sync — push/pull services to a GitHub repository with one click
  • Repository-aware save paths — Save As, Typst export, and bulletin export default to the right subfolder when a repository is configured
  • Scripture translation selector — choose WEB, KJV, ASV, or ESV in Preferences → Scripture
  • Undo / Redo — Ctrl+Z and Ctrl+Shift+Z
  • Snippets library — reusable liturgical texts (advanced mode)
  • Responsive reading builder — L:/P: syntax for formatted call-and-response text (advanced mode)
  • CSV export — for sharing with musicians and AV teams (advanced mode)

Installation

Rubric is distributed as a Flatpak via a self-hosted repository.

Add the repository

flatpak remote-add --user calstfrancis \
  https://calstfrancis.github.io/flatpak/calstfrancis.flatpakrepo

Install

flatpak install calstfrancis io.github.calstfrancis.rubric

Update

flatpak update io.github.calstfrancis.rubric

Uninstall

flatpak uninstall io.github.calstfrancis.rubric

Usage

Launch from GNOME Shell or your desktop application launcher. On first launch, a welcome wizard offers three starting points: today's lectionary, a blank service, or a guided tour. Rubric remembers the last open file and reopens it automatically on subsequent launches.


File format

Service files use the .liturgy extension (JSON). They store the service title, date, and ordered elements. Each element carries a content_typst field with Typst markup for both leader notes and bulletin text.


Running tests

python3 -m unittest test_rcl_data test_bible_api -v

Project structure

rubric.py              Main application
rcl_data.py            RCL lectionary database and calendar logic
hymn_lookup.py         Hymnary.org title fetcher (VU, MV, LUS)
hymn_suggestions.py    Season and Proper-specific hymn suggestions
bible_api.py           Bible passage fetcher (WEB, KJV, ASV, ESV)
snippets.py            Default liturgical text snippets
observances.py         Liturgical calendar and observances intelligence
rubric_package/        Packaged models, utils, exporters, and data
HELP.md                User guide
FAQ.md                 Frequently asked questions
CHANGELOG.md           Version history
RELEASE.md             Release notes for the current version

Contributing

Contributions welcome — bug reports, hymn suggestion additions, and UCC-specific liturgical content especially so.

Please open an issue before starting significant work.


Acknowledgements


License

GPL-3.0 — see LICENSE


Developed at Atlantic School of Theology, Halifax, Nova Scotia.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rubric_liturgy-0.16.0rc1.tar.gz (184.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rubric_liturgy-0.16.0rc1-py3-none-any.whl (184.2 kB view details)

Uploaded Python 3

File details

Details for the file rubric_liturgy-0.16.0rc1.tar.gz.

File metadata

  • Download URL: rubric_liturgy-0.16.0rc1.tar.gz
  • Upload date:
  • Size: 184.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for rubric_liturgy-0.16.0rc1.tar.gz
Algorithm Hash digest
SHA256 7e934fb66e3b18f65b3fd60bfca79c8dff5680cbc571ec89cd4a1a165fb2589c
MD5 387f26c5191868ac1bc0238b5268c4ff
BLAKE2b-256 95365dfab8a89845781dce84dcf33a76af6eaa1053100c7eba46d00664d71df5

See more details on using hashes here.

Provenance

The following attestation bundles were made for rubric_liturgy-0.16.0rc1.tar.gz:

Publisher: publish.yml on calstfrancis/rubric

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file rubric_liturgy-0.16.0rc1-py3-none-any.whl.

File metadata

File hashes

Hashes for rubric_liturgy-0.16.0rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 d95c16af25899d161e6374e331268385c2a68aa48becc0a20e04fea5291a271b
MD5 96be0199798c592a57a90331d2b7c104
BLAKE2b-256 ffbe744cab23bf40134a33a6d73113584f1af5d9df8973f98cd76546aca8229d

See more details on using hashes here.

Provenance

The following attestation bundles were made for rubric_liturgy-0.16.0rc1-py3-none-any.whl:

Publisher: publish.yml on calstfrancis/rubric

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page