https://github.com/aseemsavio/catholic-cli

A Command Line Tool for easy access of Catholic Resources.
https://github.com/aseemsavio/catholic-cli

catholic catholicism christian christianity cli cli-app command-line command-line-tool religion religions-studies

Last synced: 5 days ago
JSON representation

A Command Line Tool for easy access of Catholic Resources.

• Host: GitHub
• URL: https://github.com/aseemsavio/catholic-cli
• Owner: aseemsavio
• License: mit
• Created: 2022-09-30T13:47:12.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2022-12-24T06:13:21.000Z (almost 2 years ago)
• Last Synced: 2024-10-31T05:52:23.886Z (13 days ago)
• Topics: catholic, catholicism, christian, christianity, cli, cli-app, command-line, command-line-tool, religion, religions-studies
• Language: Python
• Homepage: https://github.com/aseemsavio/catholic-cli/blob/master/README.md
• Size: 4.51 MB
• Stars: 17
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 🇻🇦catholic-cli

[![Catholic CLI](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/aseemsavio/catholic-cli)

The `catholic-cli` is an awesome Catholic Theological knowledge base.

The tool currently has the following functionalities:

1. Access information from **The Catechism** of The Catholic Church,

2. Access information from **The Roman Missal**,

3. Access Information from **The Canon Law** of The Catholic Church

### Installation

The prerequisite is to have Python 3 installed on your computer.

Type the following command on your terminal to install this.

```commandline

pip3 install catholic-cli

```

To do a clean update

```commandline

pip3 uninstall catholic-cli

pip3 install catholic-cli

```

### How to Interact with Catholic CLI

Non advanced users can simply type "catholic" in their terminal to start the application.

Then you can use the arrow keys on your keyboard to select the different options.

![img.png](img.png)

More advanced users can use the command line tool similar to any other CLI.

Typing `--help` at any level displays commands and arguments you can provide to the command at that level.

![img_1.png](img_1.png)

### General Syntax

The general syntax for using the tool is as follows.

```

  

```

The default command in this CLI is `catholic`. All the sub commands are grouped under it.

The allowed sub-commands are:

1. `catechism`

2. `missal`

3. `canon`

The options currently supported by the `catholic-cli` are:

|     | Option        | Short Form | Data Type | Description                             | Commands/sub-commands that allow this option | Examples                                                                  |

|-----|---------------|------------|-----------|-----------------------------------------|----------------------------------------------|---------------------------------------------------------------------------|

| 1   | `--paragraph` | `-p`       | INT, TEXT | Displays Paragraph(s) with the given ID | `catechism`
`canon`
`missal`         | `--paragraph 10`
`-p 10`
 `-p 1-5`
`-p 1,2`
 `-p 1,2,4-5` |

| 2   | `--search`    | `-s`       | TEXT      | Search for the given string             | `catechism`
`canon`
`missal`         | `--search "Christ"`
`-s "eucharist"`
`-s "The Church"`            |

| 3   | `--help`      |            | BOOLEAN   | Get help text                           | `catholic`                                   | `--help`                                                                  |

| 4   | `--version`   |            | BOOLEAN   | Displays the version of this CLI        | `catholic`                                   | `--version`                                                               |

Feel free to send PRs my way if you're willing to contribute to this project 🍻