lectio-diei
| Crates.io | lectio-diei |
| lib.rs | lectio-diei |
| version | |
| source | src |
| created_at | 2024-07-12 23:23:30.611275 |
| updated_at | 2024-12-10 01:20:30.449899 |
| description | CLI application for displaying the daily Catholic readings |
| homepage | |
| repository | https://github.com/Squidroot2/lectio-diei |
| max_upload_size | |
| id | 1301788 |
| Cargo.toml error: | TOML parse error at line 17, column 1 | 17 | autolib = false | ^^^^^^^ unknown field `autolib`, expected one of `name`, `version`, `edition`, `authors`, `description`, `readme`, `license`, `repository`, `homepage`, `documentation`, `build`, `resolver`, `links`, `default-run`, `default_dash_run`, `rust-version`, `rust_dash_version`, `rust_version`, `license-file`, `license_dash_file`, `license_file`, `licenseFile`, `license_capital_file`, `forced-target`, `forced_dash_target`, `autobins`, `autotests`, `autoexamples`, `autobenches`, `publish`, `metadata`, `keywords`, `categories`, `exclude`, `include` |
| size | 0 |
Hayden Foley (Squidroot2)
documentation
README
Lectio Diei 
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.
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 readingslectio-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