lectio-diei

Crates.iolectio-diei
lib.rslectio-diei
version0.3.1
sourcesrc
created_at2024-07-12 23:23:30.611275
updated_at2024-08-10 16:49:57.125541
descriptionCLI application for displaying the daily Catholic readings
homepage
repositoryhttps://github.com/Squidroot2/lectio-diei
max_upload_size
id1301788
size400,351
Hayden Foley (Squidroot2)

documentation

README

Lectio Diei Crates.io Build Status dependency status

CLI application for retrieving, storing, and displaying the daily Catholic readings. Retrieved from the United States Conference of Catholic Bishops site. After being retrieved, the readings are stored in a local sqlite database. This way, they can be displayed on-demand with low latency.

While the core functionality is present, this is still pre-release software. Command line interface is subject to change.

Command Example

Compatibility

For now, only Linux is supported. The current issue is that the paths for the database, log, and config file follows the XDG specification which MacOS and Windows do not follow. I do have plans to address this.

Installation

lectio-diei can be installed from crates.io using cargo

Prerequisites

  • Install the Rust toolchain
  • Add ~/.cargo/bin to your PATH environment variable

Install with Cargo

cargo install lectio-diei --locked

After the install command completes, the lectio-diei binary will then be installed at ~/.cargo/bin. Since this is in your PATH, you should be able to execute the application with:

lectio-diei display

Usage

The most basic usage involves two commands:

  • lectio-diei db refresh - Updates your database with readings, deleting old readings
  • lectio-diei display - Displays the readings for today

More options can be seen by simply running lectio-diei

Configuration

After running any valid command at least once, you should have a config file at ~/.config/lectio-diei/config.toml. Edit this file to change number of entries stored, or default display options.

Plans for 1.0

  • Colors and formatting options for the Readings
    • Configurable line wrapping
    • Configurable colors for each reading
    • Improved heading formatting
  • Adding the Alleluia as an option
  • Config options from commandline
    • Show
    • Change
  • Windows support (maybe others?)
  • Store single day without displaying
  • No database mode
  • Database-only mode (Don't retrieve from web if you don't already have it)
  • Additional logging options
  • Formalized and documented error codes

And maybe more...

License

Licensed under the MIT license LICENSE

Commit count: 0

cargo fmt