A Command Line Utility for Accessing Information Related to The Catholic Church
Project description
🇻🇦catholic-cli
The catholic-cli
is the Swiss Army Knife Command Line Utility for quickly accessing
Catholic information. The tool currently has the following functionalities:
- Access information from The Catechism of The Catholic Church,
- Access information from The Roman Missal,
- Access Information from The Canon Law of The Catholic Church
General Syntax
The general syntax for using the tool is as follows.
catholic <resource> <options>
A resource is either catechism
, or canon
or missal
. An example for an option would be
--paragraph
or it's shortform --p
. You give values for an option like so: --p 101
, where 101
is the value passed
to the option --p
.
The allowed options are as follows.
Option | Short Form | Description | Examples |
---|---|---|---|
--paragraph |
--p |
To Query Paragraphs | --paragraph 101 --paragraph 1,2 --paragraph 1,2,6-10 --p 101 --p 101 --p 1,2 --p 1,2,6-10 |
--search |
--s |
To Look Up a given search string in Catechism / Canon / Missal. This is not case sensitive. |
--search "Christ" --s "Christ The King" |
The following command gives you paragraph 101 of the Catechism.
catholic catechism --p 101
The option --p
or --paragraph
takes in an integer (101
) or a query string (1,2,3-6
or 1,2
or 3-5
).
The query string can be a comma separated integers and, or ranges. For example:
catholic catechism --p 1,2,4-6
The above query would display paragraphs 1, 2, 4, 5, and 6. If you intend to add spaces in the query string, you may do so within double quotes as follows.
catholic catechism --p "1, 2, 4 - 6"
Here are some example commands.
Catechism
catholic catechism --paragraph 101
The tool also allows a short form for power users.
catholic c --p 101
You can provide a query string instead of an integer to --p
or --paragraph
like so:
catholic catechism --p 1,2,4-6
You can search the Catechism for words or phrases like so. The short form --s
can be used
instead of --search
.
catholic catechism --search eucharist
For searching phrases that include spaces, they must be included within quotes.
catholic c --s "child of"
Roman Missal
catholic missal --p 101
Shortform for the same would be:
catholic m --p 101
You can query the Missal like so:
catholic missal --p 1,2,3,77-79
You can search the Missal for words or phrases like so. The short form --s
can be used
instead of --search
.
catholic missal --search eucharist
For searching phrases that include spaces, they must be included within quotes.
catholic m --s "child of"
Canon Law
catholic canon --p 101
Shortform for the same would be:
catholic cl --p 101
You can query the Canon Law like so:
catholic canon --p 1,2,3,77-79
You can search the Canon Law for words or phrases like so. The short form --s
can be used
instead of --search
.
catholic canon --search eucharist
For searching phrases that include spaces, they must be included within quotes.
catholic cl --s "child of"
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
Built Distribution
Hashes for catholic_cli-0.0.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4e989bde7f26bb6ac53e2a590b40c9d8f605e6505e2ffdb0ae0dc2d1fe44f372 |
|
MD5 | 12d61de48da1355d2230fa0e6ce965d9 |
|
BLAKE2b-256 | 00202fed40d4e3e47062259dd58baaec4b2e01ecc18fe2807047940b517fa728 |