# 🇻🇦catholic-cli
[](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.
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.
### General Syntax
The general syntax for using the tool is as follows.
```
<command> <sub-command> <options>
```
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`<br/>`canon`<br/>`missal` | `--paragraph 10`<br/>`-p 10`<br/> `-p 1-5`<br/>`-p 1,2`<br/> `-p 1,2,4-5` |
| 2 | `--search` | `-s` | TEXT | Search for the given string | `catechism`<br/>`canon`<br/>`missal` | `--search "Christ"`<br/>`-s "eucharist"`<br/>`-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 🍻
Raw data
{
"_id": null,
"home_page": "https://github.com/aseemsavio/catholic-cli/blob/master/README.md",
"name": "catholic-cli",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "christianity,catholicism,catholic,christian,religion,cli",
"author": "Aseem Savio",
"author_email": "aseemsavio3@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/0f/d9/746d1c6d1795bb61daaf331cfe40f8d8c4ba5d4f0045a1b605e367f4656a/catholic-cli-1.0.0.tar.gz",
"platform": null,
"description": "# \ud83c\uddfb\ud83c\udde6catholic-cli\n\n[](https://github.com/aseemsavio/catholic-cli)\n\nThe `catholic-cli` is an awesome Catholic Theological knowledge base.\nThe tool currently has the following functionalities:\n\n1. Access information from **The Catechism** of The Catholic Church,\n2. Access information from **The Roman Missal**,\n3. Access Information from **The Canon Law** of The Catholic Church\n\n### Installation\n\nThe prerequisite is to have Python 3 installed on your computer.\n\nType the following command on your terminal to install this.\n\n```commandline\npip3 install catholic-cli\n```\n\nTo do a clean update\n\n```commandline\npip3 uninstall catholic-cli\npip3 install catholic-cli\n```\n\n### How to Interact with Catholic CLI\n\nNon advanced users can simply type \"catholic\" in their terminal to start the application.\nThen you can use the arrow keys on your keyboard to select the different options.\n\n\n\nMore advanced users can use the command line tool similar to any other CLI.\n\nTyping `--help` at any level displays commands and arguments you can provide to the command at that level.\n\n\n\n### General Syntax\n\nThe general syntax for using the tool is as follows.\n\n```\n<command> <sub-command> <options>\n```\n\nThe default command in this CLI is `catholic`. All the sub commands are grouped under it.\n\nThe allowed sub-commands are:\n\n1. `catechism`\n2. `missal`\n3. `canon`\n\nThe options currently supported by the `catholic-cli` are:\n\n| | Option | Short Form | Data Type | Description | Commands/sub-commands that allow this option | Examples |\n|-----|---------------|------------|-----------|-----------------------------------------|----------------------------------------------|---------------------------------------------------------------------------|\n| 1 | `--paragraph` | `-p` | INT, TEXT | Displays Paragraph(s) with the given ID | `catechism`<br/>`canon`<br/>`missal` | `--paragraph 10`<br/>`-p 10`<br/> `-p 1-5`<br/>`-p 1,2`<br/> `-p 1,2,4-5` |\n| 2 | `--search` | `-s` | TEXT | Search for the given string | `catechism`<br/>`canon`<br/>`missal` | `--search \"Christ\"`<br/>`-s \"eucharist\"`<br/>`-s \"The Church\"` |\n| 3 | `--help` | | BOOLEAN | Get help text | `catholic` | `--help` |\n| 4 | `--version` | | BOOLEAN | Displays the version of this CLI | `catholic` | `--version` |\n\nFeel free to send PRs my way if you're willing to contribute to this project \ud83c\udf7b\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Command Line Utility for Accessing Information Related to The Catholic Church",
"version": "1.0.0",
"split_keywords": [
"christianity",
"catholicism",
"catholic",
"christian",
"religion",
"cli"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "5234f8af6e6b87966aabc9f35ab892a3",
"sha256": "50aa03a231cde5644166769d3d3b801596f65b83b60b23aa8cc018ead39306d6"
},
"downloads": -1,
"filename": "catholic_cli-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5234f8af6e6b87966aabc9f35ab892a3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 7744022,
"upload_time": "2022-12-24T06:14:21",
"upload_time_iso_8601": "2022-12-24T06:14:21.697978Z",
"url": "https://files.pythonhosted.org/packages/17/8d/c3705b831f581e4445eded7df820b6a298b769b48e7dc228b16927613bc5/catholic_cli-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "6725a6bafbf9c6d6f981d8fca1de2aa9",
"sha256": "1b87dc59e605a4a201b40dbb67380bc3709c3902027466f18ecef02e313c5e6b"
},
"downloads": -1,
"filename": "catholic-cli-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "6725a6bafbf9c6d6f981d8fca1de2aa9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3853601,
"upload_time": "2022-12-24T06:14:24",
"upload_time_iso_8601": "2022-12-24T06:14:24.654909Z",
"url": "https://files.pythonhosted.org/packages/0f/d9/746d1c6d1795bb61daaf331cfe40f8d8c4ba5d4f0045a1b605e367f4656a/catholic-cli-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-24 06:14:24",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "catholic-cli"
}
JSON