{
    "info": {
        "author": "Brad Belyeu",
        "author_email": "bradleylamar@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "Intended Audience :: Developers",
            "License :: OSI Approved :: MIT License",
            "Operating System :: OS Independent",
            "Programming Language :: Python",
            "Programming Language :: Python :: 3",
            "Programming Language :: Python :: 3.5",
            "Programming Language :: Python :: 3.6",
            "Topic :: Software Development :: Libraries :: Python Modules"
        ],
        "description": "# USFM-References\n\n[![Build Status](https://travis-ci.org/bbelyeu/usfm-references.svg?branch=master)](https://travis-ci.org/bbelyeu/usfm-references)\n[![Coverage Status](https://coveralls.io/repos/github/bbelyeu/usfm-references/badge.svg?branch=master)](https://coveralls.io/github/bbelyeu/usfm-references?branch=master)\n\nA validator for USFM (Unified Standard Format Markers) Biblical references\n\n## Requirements\n\nThis project requires Python 3.5 or higher\n\n## Installation\n\nTo install use\n\n    pip install usfm-references\n\n## Usage\n\nImport one of the methods like\n\n    from usfm_references import valid_chapter, valid_chapter_or_intro, valid_usfm, valid_verse\n\nThe validation methods all start with `valid_`. They take a single parameter\nwhich should be a string representation of a USMF reference. And they all\nreturn a boolean value representing whether the string was valid for the\ntype that the method is validating against.\n\nFor example, if you have a string `my_reference` with a reference of Genesis 1:1,\nthe appropriate USFM reference would be `GEN.1.1`. You could use the valid_verse\nmethod to ensure it is correct like\n\n    if valid_verse(my_reference):\n        # do stuff\n\n*NOTE: These validators match a regular expression pattern. That conforms to the\ngeneral USFM standard. They do NOT ensure that the USFM actually exists in any\nparticular Bible version.*\n\nThe currently supported validators are:\n* `valid_chapter` - Ensures the passed string is a valid USFM chapter reference\n* `valid_chapter_or_intro` - Ensures the passed string is either a valid USFM chapter\nor intro reference\n* `valid_usfm` - Ensures the passed string is a valid USFM reference (can be verse, chapter, or intro)\n* `valid_verse` - Ensures the passed string is a valid USFM verse reference\n\n## Development\n\nThis project was written with Python 3.6 and is tested in CI with Python 3.5-3.6.\nOne of these must be installed before developing and testing locally.\n\nOn a mac you can use the following commands to get up and running.\n``` bash\nbrew install python3.6\n```\notherwise run\n``` bash\nbrew upgrade python3.6\n```\nto make sure you have an up to date version.\n\nThis project uses [pipenv](https://docs.pipenv.org) for dependency management. Install pipenv\n``` bash\npip3 install pipenv\n```\n\nsetup the project env\n``` base\npipenv install --three --dev\n```\n\ncreate a .env file using this sample\n``` bash\nexport PYTHONPATH=`pwd`\n```\n\nnow load virtualenv and any .env file\n```bash\npipenv shell\n```\n\n### Running tests\n\n``` bash\n./linters.sh && pytest --cov=usfm_references tests/\n```\n\n### Before committing any code\n\nWe have a pre-commit hook which should be setup.\nYou can symlink it to run before each commit by changing directory to the repo and running\n\n``` bash\ncd .git/hooks\nln -s ../../pre-commit pre-commit\n```",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "https://github.com/bbelyeu/usfm-references/archive/1.0.2.zip",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/bbelyeu/usfm-references",
        "keywords": "",
        "license": "MIT",
        "maintainer": "",
        "maintainer_email": "",
        "name": "USFM-References",
        "package_url": "https://pypi.org/project/USFM-References/",
        "platform": "any",
        "project_url": "https://pypi.org/project/USFM-References/",
        "project_urls": {
            "Download": "https://github.com/bbelyeu/usfm-references/archive/1.0.2.zip",
            "Homepage": "https://github.com/bbelyeu/usfm-references"
        },
        "release_url": "https://pypi.org/project/USFM-References/1.0.2/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "Tools to work with USFM references",
        "version": "1.0.2"
    },
    "last_serial": 4217201,
    "releases": {
        "1.0.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "56b9e6fb11f032d104a1684cbfa4be76",
                    "sha256": "b4c6d9b0acc90d6fba8e43ca60362b7340b51f40531af2186c3828870570e0f9"
                },
                "downloads": -1,
                "filename": "USFM_References-1.0.0-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "56b9e6fb11f032d104a1684cbfa4be76",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 2574,
                "upload_time": "2018-08-27T18:07:41",
                "url": "https://files.pythonhosted.org/packages/3a/d7/09d250d018a487c1d5a0e54ad8a583199d733aa231f3985611dbfb45129e/USFM_References-1.0.0-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "725475eb3cd41c1d7c36125839f241c1",
                    "sha256": "40426e33d929b08cec421f453e36595c6e1b0590469962c5b0853b269ed0da8f"
                },
                "downloads": -1,
                "filename": "USFM References-1.0.0.tar.gz",
                "has_sig": false,
                "md5_digest": "725475eb3cd41c1d7c36125839f241c1",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 3930,
                "upload_time": "2018-08-27T18:07:42",
                "url": "https://files.pythonhosted.org/packages/42/d3/2b811608b108b9f66f95c6823ca4e487c5437aece92b49afb9b466e4fed3/USFM%20References-1.0.0.tar.gz"
            }
        ],
        "1.0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "9c0a0856441424e62da8e6d3034ab0b3",
                    "sha256": "a95c063646cffaf3269ad6cab2837f64ed35b74d4140eb5d48dec7ab1101ecee"
                },
                "downloads": -1,
                "filename": "USFM_References-1.0.1-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "9c0a0856441424e62da8e6d3034ab0b3",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 3528,
                "upload_time": "2018-08-27T18:48:15",
                "url": "https://files.pythonhosted.org/packages/85/05/d303a12bf71a67e83b49387c1dbe4048e2c6bfa1fd77522f6f00f7c94bcf/USFM_References-1.0.1-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "8ce26897b7ddecc8fdcfaf2c6f54573f",
                    "sha256": "91148290891333d40e309761ce71d0f6b5a025e67f8e7a7d2253fdbd0a34a6c6"
                },
                "downloads": -1,
                "filename": "USFM References-1.0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "8ce26897b7ddecc8fdcfaf2c6f54573f",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 4028,
                "upload_time": "2018-08-27T18:48:04",
                "url": "https://files.pythonhosted.org/packages/80/9d/e3d5dbbf85661dc1f9b1115eb566d567472917c6832d5077bc33a53e4a87/USFM%20References-1.0.1.tar.gz"
            }
        ],
        "1.0.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "2486bea52929b29ee733c14cfad3a345",
                    "sha256": "fec2ba5843cfce31cd7fb0ecb9b8d26a31cd972f47bef11e1cc5abea62287b2b"
                },
                "downloads": -1,
                "filename": "USFM_References-1.0.2-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "2486bea52929b29ee733c14cfad3a345",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 3556,
                "upload_time": "2018-08-29T01:25:00",
                "url": "https://files.pythonhosted.org/packages/db/7d/7632926380fe1cf1b3468b22c80a0aef2ee56a050442c008587be3df1838/USFM_References-1.0.2-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "cebd9e81fd797274a17f24acf0f4d36f",
                    "sha256": "84f9311b5bcd504d1b823da4f4c7b86ce81956613ce64cdd400f244fe30c995f"
                },
                "downloads": -1,
                "filename": "USFM References-1.0.2.tar.gz",
                "has_sig": false,
                "md5_digest": "cebd9e81fd797274a17f24acf0f4d36f",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 4063,
                "upload_time": "2018-08-29T01:24:49",
                "url": "https://files.pythonhosted.org/packages/f5/41/4b26d2545733cd02b5942e463c868a9eb78a08770f2e6c8514bb3b5c1c56/USFM%20References-1.0.2.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "2486bea52929b29ee733c14cfad3a345",
                "sha256": "fec2ba5843cfce31cd7fb0ecb9b8d26a31cd972f47bef11e1cc5abea62287b2b"
            },
            "downloads": -1,
            "filename": "USFM_References-1.0.2-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2486bea52929b29ee733c14cfad3a345",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 3556,
            "upload_time": "2018-08-29T01:25:00",
            "url": "https://files.pythonhosted.org/packages/db/7d/7632926380fe1cf1b3468b22c80a0aef2ee56a050442c008587be3df1838/USFM_References-1.0.2-py2.py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "cebd9e81fd797274a17f24acf0f4d36f",
                "sha256": "84f9311b5bcd504d1b823da4f4c7b86ce81956613ce64cdd400f244fe30c995f"
            },
            "downloads": -1,
            "filename": "USFM References-1.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "cebd9e81fd797274a17f24acf0f4d36f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 4063,
            "upload_time": "2018-08-29T01:24:49",
            "url": "https://files.pythonhosted.org/packages/f5/41/4b26d2545733cd02b5942e463c868a9eb78a08770f2e6c8514bb3b5c1c56/USFM%20References-1.0.2.tar.gz"
        }
    ]
}