lcr-session


Namelcr-session JSON
Version 1.0.3 PyPI version JSON
download
home_pagehttps://github.com/IsaacsLab42/lcr_session
SummarySession authentication to the Church of Jesus Christ of Latter Day Saints LCR System
upload_time2024-09-23 22:24:57
maintainerNone
docs_urlNone
authorIsaac Wagner
requires_python<4.0,>=3.10
licenseMIT
keywords lcr churchofjesuschrist
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # LCR Session

<p>
    <a href="https://lcr-session.readthedocs.io/en/stable/">
        <img src="https://img.shields.io/readthedocs/lcr-session"/>
    </a>
    <a href="https://pypi.org/project/lcr-session/">
        <img src="https://img.shields.io/pypi/v/lcr-session"/>
    </a>
    <a href="https://pypi.org/project/lcr-session/">
        <img src="https://img.shields.io/pypi/wheel/lcr-session"/>
    </a>
    <a href="https://pypi.org/project/lcr-session/">
        <img src="https://img.shields.io/pypi/pyversions/lcr-session"/>
    </a>
    <a href="https://github.com/IsaacsLab42/lcr_session/">
        <img src="https://img.shields.io/github/license/IsaacsLab42/lcr_session"/>
    </a>
    <a href="https://black.readthedocs.io/en/stable/">
        <img src="https://img.shields.io/badge/code_style-black-black"/>
    </a>
</p>

---

This library provides session authentication to the [Church of Jesus Christ of Latter
Day Saints](https://www.churchofjesuschrist.org) Leader and Clerk Resources (LCR)
System. This uses the very capable
[Requests](https://requests.readthedocs.io/en/stable/) package to drive the web
connection.

This library can also save the cookies from an established session, which means that
once you authenticate you can repeatedly use your scripts without have to
reauthenticate.

> This in an unofficial and independent project. In no way is this officially
> associated with The Church of Jesus Christ of Latter-Day Saints.

## Quick Start

Here's a very simple and quick illustration of how to use the API:

```python
import pprint
from lcr_session import LcrSession, ChurchUrl

endpoint_url = ChurchUrl("lcr", "api/report/members-with-callings?unitNumber={unit}")
api = LcrSession(USERNAME, PASSWORD, cookie_jar_file="cookies.txt")
resp = api.get_json(endpoint_url)
pprint.pprint(resp)
```

See the documentation at: https://lcr-session.readthedocs.io/en/stable/.


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/IsaacsLab42/lcr_session",
    "name": "lcr-session",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.10",
    "maintainer_email": null,
    "keywords": "lcr, churchofjesuschrist",
    "author": "Isaac Wagner",
    "author_email": "14634+IsaacsLab42@users.noreply.github.com",
    "download_url": "https://files.pythonhosted.org/packages/1e/8b/833f7603d5a57df7e3efce8b90649b1c42a2586669c4409cc0ef8c62b53c/lcr_session-1.0.3.tar.gz",
    "platform": null,
    "description": "# LCR Session\n\n<p>\n    <a href=\"https://lcr-session.readthedocs.io/en/stable/\">\n        <img src=\"https://img.shields.io/readthedocs/lcr-session\"/>\n    </a>\n    <a href=\"https://pypi.org/project/lcr-session/\">\n        <img src=\"https://img.shields.io/pypi/v/lcr-session\"/>\n    </a>\n    <a href=\"https://pypi.org/project/lcr-session/\">\n        <img src=\"https://img.shields.io/pypi/wheel/lcr-session\"/>\n    </a>\n    <a href=\"https://pypi.org/project/lcr-session/\">\n        <img src=\"https://img.shields.io/pypi/pyversions/lcr-session\"/>\n    </a>\n    <a href=\"https://github.com/IsaacsLab42/lcr_session/\">\n        <img src=\"https://img.shields.io/github/license/IsaacsLab42/lcr_session\"/>\n    </a>\n    <a href=\"https://black.readthedocs.io/en/stable/\">\n        <img src=\"https://img.shields.io/badge/code_style-black-black\"/>\n    </a>\n</p>\n\n---\n\nThis library provides session authentication to the [Church of Jesus Christ of Latter\nDay Saints](https://www.churchofjesuschrist.org) Leader and Clerk Resources (LCR)\nSystem. This uses the very capable\n[Requests](https://requests.readthedocs.io/en/stable/) package to drive the web\nconnection.\n\nThis library can also save the cookies from an established session, which means that\nonce you authenticate you can repeatedly use your scripts without have to\nreauthenticate.\n\n> This in an unofficial and independent project. In no way is this officially\n> associated with The Church of Jesus Christ of Latter-Day Saints.\n\n## Quick Start\n\nHere's a very simple and quick illustration of how to use the API:\n\n```python\nimport pprint\nfrom lcr_session import LcrSession, ChurchUrl\n\nendpoint_url = ChurchUrl(\"lcr\", \"api/report/members-with-callings?unitNumber={unit}\")\napi = LcrSession(USERNAME, PASSWORD, cookie_jar_file=\"cookies.txt\")\nresp = api.get_json(endpoint_url)\npprint.pprint(resp)\n```\n\nSee the documentation at: https://lcr-session.readthedocs.io/en/stable/.\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Session authentication to the Church of Jesus Christ of Latter Day Saints LCR System",
    "version": "1.0.3",
    "project_urls": {
        "Bug Tracker": "https://github.com/IsaacsLab42/lcr_session/issues",
        "Documentation": "https://lcr-session.readthedocs.io/en/stable/",
        "Homepage": "https://github.com/IsaacsLab42/lcr_session",
        "Repository": "https://github.com/IsaacsLab42/lcr_session"
    },
    "split_keywords": [
        "lcr",
        " churchofjesuschrist"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "edf358f0d8b0da305a09cd662eee233c685b29aa58f9d799cac99951b1e722e6",
                "md5": "66e84fa2264f35fada02cf3d1829ffe1",
                "sha256": "20d6df538dc91a0caff49048cb31496af2f12b7e6f4ce00ea5ad6155b4139451"
            },
            "downloads": -1,
            "filename": "lcr_session-1.0.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "66e84fa2264f35fada02cf3d1829ffe1",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.10",
            "size": 8392,
            "upload_time": "2024-09-23T22:24:56",
            "upload_time_iso_8601": "2024-09-23T22:24:56.076413Z",
            "url": "https://files.pythonhosted.org/packages/ed/f3/58f0d8b0da305a09cd662eee233c685b29aa58f9d799cac99951b1e722e6/lcr_session-1.0.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1e8b833f7603d5a57df7e3efce8b90649b1c42a2586669c4409cc0ef8c62b53c",
                "md5": "53fcfe72b1e4d98cb8c74e4b425c7438",
                "sha256": "17e3769017471ea0650ff9f860b1464876c6d29a63829e4d8618bce5a0faea27"
            },
            "downloads": -1,
            "filename": "lcr_session-1.0.3.tar.gz",
            "has_sig": false,
            "md5_digest": "53fcfe72b1e4d98cb8c74e4b425c7438",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.10",
            "size": 7006,
            "upload_time": "2024-09-23T22:24:57",
            "upload_time_iso_8601": "2024-09-23T22:24:57.644614Z",
            "url": "https://files.pythonhosted.org/packages/1e/8b/833f7603d5a57df7e3efce8b90649b1c42a2586669c4409cc0ef8c62b53c/lcr_session-1.0.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-23 22:24:57",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "IsaacsLab42",
    "github_project": "lcr_session",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "lcr-session"
}
        
Elapsed time: 2.41848s