Skip to main content

A terminal UI to guide users through the Rosary

Project description

rosary

rosary is a terminal application for praying the Holy Rosary step by step. It guides you through the opening prayers, the five decades, and the closing prayers in a clean Textual interface, with mystery descriptions and scripture references included along the way.

Features

  • Guided Rosary flow from beginning to end
  • English and Latin prayer modes
  • Bible translation selection in English mode
  • Automatic mystery recommendation based on the day of the week
  • Intentions prompt before the Rosary begins
  • Scripture lookups for mysteries with direct biblical references
  • Built-in fallback translation list if the live API is unavailable

Requirements

  • Python 3.13 or newer
  • A terminal that supports Textual applications
  • Internet access for live translation and scripture fetching

Installation

From PyPI

pip install rosary

If you prefer an isolated CLI install:

pipx install rosary

Quick start

Run the app with:

rosary

You will then:

  1. Choose English or Latin.
  2. Select a Bible translation in English mode.
  3. Accept the suggested mystery set for the day or choose another one.
  4. Offer your intentions.
  5. Move through the Rosary one step at a time.

Mystery schedule

The app suggests the traditional mystery set for the current weekday:

Day Mysteries
Monday Joyful
Tuesday Sorrowful
Wednesday Glorious
Thursday Luminous
Friday Sorrowful
Saturday Joyful
Sunday Glorious

You can always override the suggestion from the selection screen.

Keyboard controls

Selection screens

  • q to quit
  • escape to go back when available
  • arrow keys to move through options
  • enter to confirm a selection

Rosary screen

  • space or right arrow for the next step
  • backspace or left arrow for the previous step
  • q to quit
  • r to start again after completion

Included prayer flow

The guided flow includes:

  • Sign of the Cross
  • Apostles' Creed
  • Our Father
  • three Hail Marys
  • Glory Be
  • five decades with mystery descriptions
  • Hail Holy Queen
  • Closing Prayer
  • Sign of the Cross

For mysteries such as the Assumption and Coronation, the app shows a doctrinal note when no direct scripture passage is used.

Development

To work on the project locally:

python -m venv .venv
source .venv/bin/activate
pip install -e .

Or with uv:

uv sync
uv run rosary

Project layout

src/rosary/
├── api.py              # bible-api.com client
├── app.py              # top-level Textual app
├── main.py             # CLI entry point
├── mysteries.py        # mystery definitions and weekday suggestion logic
├── prayers.py          # English and Latin prayer texts
└── screens/
    ├── welcome.py
    ├── mystery_select.py
    ├── intentions.py
    └── rosary.py

License

See LICENSE.

Project details


Download files

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

Source Distribution

rosary-1.0.1.tar.gz (12.1 kB view details)

Uploaded Source

Built Distribution

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

rosary-1.0.1-py3-none-any.whl (16.6 kB view details)

Uploaded Python 3

File details

Details for the file rosary-1.0.1.tar.gz.

File metadata

  • Download URL: rosary-1.0.1.tar.gz
  • Upload date:
  • Size: 12.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.18 {"installer":{"name":"uv","version":"0.9.18","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for rosary-1.0.1.tar.gz
Algorithm Hash digest
SHA256 5575c730dcd358c3bdbf6a53fb87c05f40a3f43d362401bd00f53c0730938a36
MD5 0714a2859356ccde6061d14d30e75e2a
BLAKE2b-256 4d3ab648f9984bd498405d1a52334aa9b5b0f66698563bd9704d672f0719b996

See more details on using hashes here.

File details

Details for the file rosary-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: rosary-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 16.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.18 {"installer":{"name":"uv","version":"0.9.18","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for rosary-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7b521e9e9c36e67fda4ed8eb751be8d37bbcc7868f640038a0307719f208c61a
MD5 17ec0eebe49cdabaafb48716dc5464da
BLAKE2b-256 c8d870e9e50b416c4d9d3eadb625b49755c75bdd0214f063b613e6398817da83

See more details on using hashes here.

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