bibleparser


Namebibleparser JSON
Version 0.0.2 PyPI version JSON
download
home_pageNone
SummaryParse a mistranscribed dictated bible reference into a standard format
upload_time2024-10-25 11:06:25
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseMIT
keywords bible parser reference passage dictation transcription text processing siri alexa
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Bible Parser

Bible Parser is a Python library for parsing a Bible reference into a structured format. It was designed to interpret dictated references that may have been mistranscribed by Siri or other voice recognition software (e.g., "John 316" becomes "John 3:16").


## Examples

Dictation                   | Transcription     | Parsed Reference
---------                   | -------------     | ----------------
john three sixteen          | John 316          | John 3:16
john three two through four | John 32 through 4 | John 3:2-4
matthew twenty one twelve   | Matthew 2112      | Matthew 21:12
first john one one          | 1st John 11       | 1 John 1:1
micah one one               | Michael 11        | Micah 1:1
jude one one                | June one one      | Jude 1:1
haggai two twenty three     | Hey guy 223       | Haggai 2:23
acts one twenty three       | X123              | Acts 1:23


## API

### Siri Shortcut
I originally created this project to use with a Siri Shortcut that accepts a Bible reference as input and returns the text of the passage.

### AWS Serverless API
I set up an AWS Lambda function behind an API Gateway to expose the functionality of this library as an HTTP API.

### Bible API by Tim Morgan
Special thanks to Tim Morgan for creating and hosting [bible-api](https://bible-api.com/)! My library merely parses the reference. Tim's API provides the actual text of the passage.


## Quick Reference Commands

Action                     | Command
------                     | -------
Create virtual environment | `python -m venv venv`
Activate venv              | `source venv/bin/activate`
Deactivate venv            | `deactivate`
Install package (editable) | `pip install -e .`
Run all tests              | `python -m unittest discover tests`
Build the package          | `python -m build`
Upload to PyPI             | `twine upload dist/*`

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "bibleparser",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "bible, parser, reference, passage, dictation, transcription, text processing, siri, alexa",
    "author": null,
    "author_email": "Taylor Vance <mirrors.cities0w@icloud.com>",
    "download_url": "https://files.pythonhosted.org/packages/8a/aa/9ef41bc7c9009fa74bd2c379d4775b3495171e30d8f9be9e322985899806/bibleparser-0.0.2.tar.gz",
    "platform": null,
    "description": "# Bible Parser\n\nBible Parser is a Python library for parsing a Bible reference into a structured format. It was designed to interpret dictated references that may have been mistranscribed by Siri or other voice recognition software (e.g., \"John 316\" becomes \"John 3:16\").\n\n\n## Examples\n\nDictation                   | Transcription     | Parsed Reference\n---------                   | -------------     | ----------------\njohn three sixteen          | John 316          | John 3:16\njohn three two through four | John 32 through 4 | John 3:2-4\nmatthew twenty one twelve   | Matthew 2112      | Matthew 21:12\nfirst john one one          | 1st John 11       | 1 John 1:1\nmicah one one               | Michael 11        | Micah 1:1\njude one one                | June one one      | Jude 1:1\nhaggai two twenty three     | Hey guy 223       | Haggai 2:23\nacts one twenty three       | X123              | Acts 1:23\n\n\n## API\n\n### Siri Shortcut\nI originally created this project to use with a Siri Shortcut that accepts a Bible reference as input and returns the text of the passage.\n\n### AWS Serverless API\nI set up an AWS Lambda function behind an API Gateway to expose the functionality of this library as an HTTP API.\n\n### Bible API by Tim Morgan\nSpecial thanks to Tim Morgan for creating and hosting [bible-api](https://bible-api.com/)! My library merely parses the reference. Tim's API provides the actual text of the passage.\n\n\n## Quick Reference Commands\n\nAction                     | Command\n------                     | -------\nCreate virtual environment | `python -m venv venv`\nActivate venv              | `source venv/bin/activate`\nDeactivate venv            | `deactivate`\nInstall package (editable) | `pip install -e .`\nRun all tests              | `python -m unittest discover tests`\nBuild the package          | `python -m build`\nUpload to PyPI             | `twine upload dist/*`\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Parse a mistranscribed dictated bible reference into a standard format",
    "version": "0.0.2",
    "project_urls": {
        "Homepage": "https://github.com/taylorvance/bibleparser",
        "Issues": "https://github.com/taylorvance/bibleparser/issues"
    },
    "split_keywords": [
        "bible",
        " parser",
        " reference",
        " passage",
        " dictation",
        " transcription",
        " text processing",
        " siri",
        " alexa"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8e0a4235e3ac4cb6a6d2eea0784c7e4cfd73e5c1590d1990b7f2920f8cbf98c8",
                "md5": "f98a736ceddaa81aacb505da53abc2fd",
                "sha256": "3ad42c3acdaed57f60fabe2f9c2031e383072a28aa6f45927bdb39a0b8cf47e6"
            },
            "downloads": -1,
            "filename": "bibleparser-0.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f98a736ceddaa81aacb505da53abc2fd",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 9400,
            "upload_time": "2024-10-25T11:06:24",
            "upload_time_iso_8601": "2024-10-25T11:06:24.151122Z",
            "url": "https://files.pythonhosted.org/packages/8e/0a/4235e3ac4cb6a6d2eea0784c7e4cfd73e5c1590d1990b7f2920f8cbf98c8/bibleparser-0.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8aaa9ef41bc7c9009fa74bd2c379d4775b3495171e30d8f9be9e322985899806",
                "md5": "f19982c311d120ebd2f60a16538a1dd4",
                "sha256": "2a42a1c4f6a7429f79fa57517c1d9a38419231c6b2e77f6006d8078ffd72eeea"
            },
            "downloads": -1,
            "filename": "bibleparser-0.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "f19982c311d120ebd2f60a16538a1dd4",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 11211,
            "upload_time": "2024-10-25T11:06:25",
            "upload_time_iso_8601": "2024-10-25T11:06:25.387758Z",
            "url": "https://files.pythonhosted.org/packages/8a/aa/9ef41bc7c9009fa74bd2c379d4775b3495171e30d8f9be9e322985899806/bibleparser-0.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-25 11:06:25",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "taylorvance",
    "github_project": "bibleparser",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "bibleparser"
}
        
Elapsed time: 0.38148s