# SWORD Converter
[![Test](https://github.com/evnskc/sword-converter/actions/workflows/test.yml/badge.svg)](https://github.com/evnskc/sword-converter/actions/workflows/test.yml)
[![Publish](https://github.com/evnskc/sword-converter/actions/workflows/publish.yml/badge.svg)](https://github.com/evnskc/sword-converter/actions/workflows/publish.yml)
[![PyPI](https://img.shields.io/pypi/v/sword-converter)](https://pypi.org/project/sword-converter/)
## Generate JSON Files and SQLite Databases of Bible Texts from SWORD Modules
The [SWORD project provides modules](http://crosswire.org/sword/modules/ModDisp.jsp?modType=Bibles) freely for common
Bible translations in different languages.
### Sample Output
#### _1. JSON_
```json
{
"name": "King James Version (1769) with Strongs Numbers and Morphology and CatchWords",
"abbreviation": "KJV",
"books": {
"ot": [
{
"number": 1,
"name": "Genesis",
"abbreviation": "Gen",
"chapters": [
{
"number": 1,
"verses": [
{
"number": 1,
"text": "In the beginning God created the heaven and the earth."
}
]
}
]
}
],
"nt": [
{
"number": 40,
"name": "Matthew",
"abbreviation": "Matt",
"chapters": [
{
"number": 1,
"verses": [
{
"number": 1,
"text": "The book of the generation of Jesus Christ, the son of David, the son of Abraham."
}
]
}
]
}
]
}
}
```
#### _2. SQLite_
- Translations
```text
+-----------------------------------------------------------------------------+------------+
|name |abbreviation|
+-----------------------------------------------------------------------------+------------+
|King James Version (1769) with Strongs Numbers and Morphology and CatchWords|KJV |
+-----------------------------------------------------------------------------+------------+
```
- Books
```text
+-----------+------+-------+------------+---------+
|translation|number|name |abbreviation|testament|
+-----------+------+-------+------------+---------+
|1 |1 |Genesis|Gen |ot |
+-----------+------+-------+------------+---------+
```
- Chapters
```text
+----+------+
|book|number|
+----+------+
|1 |1 |
+----+------+
```
- Verses
```text
+-------+------+------------------------------------------------------+
|chapter|number|text |
+-------+------+------------------------------------------------------+
|1 |1 |In the beginning God created the heaven and the earth.|
+-------+------+------------------------------------------------------+
```
### Installation
Using `pip`
```commandline
pip install sword-converter
```
Using `poetry`
```commandline
poetry add sword-converter
```
### Usage
Output file will be saved in the same directory as the sword module.
```text
sword-converter source module -f {json,sqlite}
```
```commandline
sword-converter /home/user/Downloads/KJV.zip KJV -f json
```
```commandline
sword-converter /home/user/Downloads/KJV.zip KJV -f sqlite
```
Raw data
{
"_id": null,
"home_page": "https://github.com/evnskc/sword-converter",
"name": "sword-converter",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<4.0",
"maintainer_email": "",
"keywords": "SWORD,Converter,Bible Text,JSON,SQLite",
"author": "Evans",
"author_email": "evans@fundi.dev",
"download_url": "https://files.pythonhosted.org/packages/e6/e6/77b37977adc40e8f31e3048bedf7413c90922c8909142b17746166da834b/sword_converter-2.0.0.tar.gz",
"platform": null,
"description": "# SWORD Converter\n\n[![Test](https://github.com/evnskc/sword-converter/actions/workflows/test.yml/badge.svg)](https://github.com/evnskc/sword-converter/actions/workflows/test.yml)\n[![Publish](https://github.com/evnskc/sword-converter/actions/workflows/publish.yml/badge.svg)](https://github.com/evnskc/sword-converter/actions/workflows/publish.yml)\n[![PyPI](https://img.shields.io/pypi/v/sword-converter)](https://pypi.org/project/sword-converter/)\n\n## Generate JSON Files and SQLite Databases of Bible Texts from SWORD Modules\n\nThe [SWORD project provides modules](http://crosswire.org/sword/modules/ModDisp.jsp?modType=Bibles) freely for common\nBible translations in different languages.\n\n### Sample Output\n\n#### _1. JSON_\n\n```json\n{\n \"name\": \"King James Version (1769) with Strongs Numbers and Morphology and CatchWords\",\n \"abbreviation\": \"KJV\",\n \"books\": {\n \"ot\": [\n {\n \"number\": 1,\n \"name\": \"Genesis\",\n \"abbreviation\": \"Gen\",\n \"chapters\": [\n {\n \"number\": 1,\n \"verses\": [\n {\n \"number\": 1,\n \"text\": \"In the beginning God created the heaven and the earth.\"\n }\n ]\n }\n ]\n }\n ],\n \"nt\": [\n {\n \"number\": 40,\n \"name\": \"Matthew\",\n \"abbreviation\": \"Matt\",\n \"chapters\": [\n {\n \"number\": 1,\n \"verses\": [\n {\n \"number\": 1,\n \"text\": \"The book of the generation of Jesus Christ, the son of David, the son of Abraham.\"\n }\n ]\n }\n ]\n }\n ]\n }\n}\n```\n\n#### _2. SQLite_\n\n- Translations\n\n```text\n+-----------------------------------------------------------------------------+------------+\n|name |abbreviation|\n+-----------------------------------------------------------------------------+------------+\n|King James Version (1769) with Strongs Numbers and Morphology and CatchWords|KJV |\n+-----------------------------------------------------------------------------+------------+\n```\n\n- Books\n\n```text\n+-----------+------+-------+------------+---------+\n|translation|number|name |abbreviation|testament|\n+-----------+------+-------+------------+---------+\n|1 |1 |Genesis|Gen |ot |\n+-----------+------+-------+------------+---------+\n```\n\n- Chapters\n\n```text\n+----+------+\n|book|number|\n+----+------+\n|1 |1 |\n+----+------+\n```\n\n- Verses\n\n```text\n+-------+------+------------------------------------------------------+\n|chapter|number|text |\n+-------+------+------------------------------------------------------+\n|1 |1 |In the beginning God created the heaven and the earth.|\n+-------+------+------------------------------------------------------+\n```\n\n### Installation\n\nUsing `pip`\n\n```commandline\npip install sword-converter\n```\n\nUsing `poetry`\n\n```commandline\npoetry add sword-converter\n```\n\n### Usage\n\nOutput file will be saved in the same directory as the sword module.\n\n```text\nsword-converter source module -f {json,sqlite}\n```\n\n```commandline\nsword-converter /home/user/Downloads/KJV.zip KJV -f json\n```\n\n```commandline\nsword-converter /home/user/Downloads/KJV.zip KJV -f sqlite\n```\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": "Generate JSON Files and SQLite Databases of Bible Texts from SWORD Modules",
"version": "2.0.0",
"project_urls": {
"Documentation": "https://github.com/evnskc/sword-converter",
"Homepage": "https://github.com/evnskc/sword-converter",
"Repository": "https://github.com/evnskc/sword-converter"
},
"split_keywords": [
"sword",
"converter",
"bible text",
"json",
"sqlite"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "232a77efedf9cae3fa83655da3e2f19b8f7e6eddbe1ac58b025db55096efaf6b",
"md5": "6bc901ea592bd435ef61bebc96f74a68",
"sha256": "016b11d71ff59ab33e9e6e46f5b0d9ab5344794dab7fca473f6a2f173c322183"
},
"downloads": -1,
"filename": "sword_converter-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6bc901ea592bd435ef61bebc96f74a68",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<4.0",
"size": 18128,
"upload_time": "2024-03-05T05:11:11",
"upload_time_iso_8601": "2024-03-05T05:11:11.534287Z",
"url": "https://files.pythonhosted.org/packages/23/2a/77efedf9cae3fa83655da3e2f19b8f7e6eddbe1ac58b025db55096efaf6b/sword_converter-2.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e6e677b37977adc40e8f31e3048bedf7413c90922c8909142b17746166da834b",
"md5": "402de77b499395c4963f3f7badd16348",
"sha256": "fc6ad3355a138bee66a68671caf377dba93196813ed09c033a71c5ac8cbfd8c5"
},
"downloads": -1,
"filename": "sword_converter-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "402de77b499395c4963f3f7badd16348",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<4.0",
"size": 16347,
"upload_time": "2024-03-05T05:11:13",
"upload_time_iso_8601": "2024-03-05T05:11:13.050186Z",
"url": "https://files.pythonhosted.org/packages/e6/e6/77b37977adc40e8f31e3048bedf7413c90922c8909142b17746166da834b/sword_converter-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-05 05:11:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "evnskc",
"github_project": "sword-converter",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "sword-converter"
}