| Name | pylect JSON |
| Version |
0.3.3
JSON |
| download |
| home_page | None |
| Summary | Tools for working with the Anglican lectionary. |
| upload_time | 2024-06-03 17:58:08 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.12 |
| license | MIT License Copyright (c) 2024 William Wingate Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
lectionary
liturgy
calendar
anglican
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# pylect
Pylect is a CLI program that searches the Sunday, Holy Day, and Commemoration Lectionary in the [Book of Common Prayer 2019](https://bcp2019.anglicanchurch.net/) for any upcoming holy days within a given date range and returns their corresponding Scripture lessons. When desired, it can then fetch the text of the Scripture lessons and automatically copy them to the system clipboard.
## Purpose
This is my first personal project! So, the purpose is to try my hand at making something from start to finish with nothing but my own inspiration to guide me. Practically speaking, the impetus for this project is the many hours I've spent creating bulletins and Scripture inserts for my local church. Calculating the correct day in the liturgical calendar, looking up the appropriate Scripture references in the lectionary, and then copying, pasting, and formatting the texts from different PDFs and websites has always been laborious and error-prone. This is my attempt to automate some of the boring stuff in my own life, and hopefully you find it useful too!
## Installation
Pylect is a program written in Python 3. If you don't already have Python installed, head over to the official Python [website](https://www.python.org/) and download the latest version.
Pylect is published on the [Python Package Index](https://pypi.org/project/pylect/), so the easiest way to install it is by simply running `pip install pylect` from the command line.
Next, you will need to get your own ESV API key from [here](https://api.esv.org/) if you want to be able to automatically fetch and copy the Scripture texts into your clipboard. Once you have the key, create a `.env` file in the root Pylect directory and add your key like so:
```
ESV_API_KEY=<your key goes here>
```
## Usage
Run Pylect from the command line with `python3 -m pylect <start_date> <end_date>` or (more simply) with `pylect <start_date> <end_date>`. The start and end dates are optional arguments and must be in the format `YYYY-MM-DD`. When not given any arguments, the program will take the current date as a starting point and return all the liturgical days in the coming week. The results will be printed to your screen. You can select any of the days by entering their corresponding number and Pylect will fetch the text of the lessons for you and copy them to your system clipboard. When you're finished, simply enter `q` to quit the program.
## Examples
With no optional arguments, Pylect will return all liturgical days ocurring over the next 7 days:
```
pylect
```
With the start date argument only, Pylect will return all liturgical days between June 8th and June 15th, 2024:
```
pylect 2024-06-08
```
With both the start and end date arguments, Pylect will return all liturgical days between June 8th and November 1st, 2024:
```
pylect 2024-06-08 2024-11-1
```
## Credits
- The Book of Common Prayer 2019 was produced by the Anglican Church of North America and is freely available for download at the [official website](https://bcp2019.anglicanchurch.net/).
- The JSON-ified text of the Psalms is pulled from the [Daily Office API](https://api.dailyoffice2019.com/api/) created by [Benjamin Locher](https://github.com/blocher). Much thanks to him for doing the hard work of wrangling the PDF text of the New Coverdale Psalter into a usable format!
## Contributing
I would like to develop this into a tool that can be used by multiple denominations with multiple lectionaries, so feedback and pull requests are more than welcome!
Raw data
{
"_id": null,
"home_page": null,
"name": "pylect",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "lectionary, liturgy, calendar, anglican",
"author": null,
"author_email": "William Wingate <wtwingate@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/90/72/2b0b7a44e51988bf836cfccf296e6a372684d625774672b01fe05ee8d314/pylect-0.3.3.tar.gz",
"platform": null,
"description": "# pylect\n\nPylect is a CLI program that searches the Sunday, Holy Day, and Commemoration Lectionary in the [Book of Common Prayer 2019](https://bcp2019.anglicanchurch.net/) for any upcoming holy days within a given date range and returns their corresponding Scripture lessons. When desired, it can then fetch the text of the Scripture lessons and automatically copy them to the system clipboard.\n\n## Purpose\n\nThis is my first personal project! So, the purpose is to try my hand at making something from start to finish with nothing but my own inspiration to guide me. Practically speaking, the impetus for this project is the many hours I've spent creating bulletins and Scripture inserts for my local church. Calculating the correct day in the liturgical calendar, looking up the appropriate Scripture references in the lectionary, and then copying, pasting, and formatting the texts from different PDFs and websites has always been laborious and error-prone. This is my attempt to automate some of the boring stuff in my own life, and hopefully you find it useful too!\n\n## Installation\n\nPylect is a program written in Python 3. If you don't already have Python installed, head over to the official Python [website](https://www.python.org/) and download the latest version.\n\nPylect is published on the [Python Package Index](https://pypi.org/project/pylect/), so the easiest way to install it is by simply running `pip install pylect` from the command line.\n\nNext, you will need to get your own ESV API key from [here](https://api.esv.org/) if you want to be able to automatically fetch and copy the Scripture texts into your clipboard. Once you have the key, create a `.env` file in the root Pylect directory and add your key like so:\n\n```\nESV_API_KEY=<your key goes here>\n```\n\n## Usage\n\nRun Pylect from the command line with `python3 -m pylect <start_date> <end_date>` or (more simply) with `pylect <start_date> <end_date>`. The start and end dates are optional arguments and must be in the format `YYYY-MM-DD`. When not given any arguments, the program will take the current date as a starting point and return all the liturgical days in the coming week. The results will be printed to your screen. You can select any of the days by entering their corresponding number and Pylect will fetch the text of the lessons for you and copy them to your system clipboard. When you're finished, simply enter `q` to quit the program.\n\n## Examples\n\nWith no optional arguments, Pylect will return all liturgical days ocurring over the next 7 days:\n\n```\npylect\n```\n\nWith the start date argument only, Pylect will return all liturgical days between June 8th and June 15th, 2024:\n\n```\npylect 2024-06-08\n```\n\nWith both the start and end date arguments, Pylect will return all liturgical days between June 8th and November 1st, 2024:\n\n```\npylect 2024-06-08 2024-11-1\n```\n\n## Credits\n\n- The Book of Common Prayer 2019 was produced by the Anglican Church of North America and is freely available for download at the [official website](https://bcp2019.anglicanchurch.net/).\n\n- The JSON-ified text of the Psalms is pulled from the [Daily Office API](https://api.dailyoffice2019.com/api/) created by [Benjamin Locher](https://github.com/blocher). Much thanks to him for doing the hard work of wrangling the PDF text of the New Coverdale Psalter into a usable format!\n\n## Contributing\n\nI would like to develop this into a tool that can be used by multiple denominations with multiple lectionaries, so feedback and pull requests are more than welcome!\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 William Wingate Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Tools for working with the Anglican lectionary.",
"version": "0.3.3",
"project_urls": {
"Repository": "https://github.com/wtwingate/pylect"
},
"split_keywords": [
"lectionary",
" liturgy",
" calendar",
" anglican"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4041f78a79784cc001d3ab15b8fbd6278a620e01213c1e28547afb5fd808f2a4",
"md5": "7df810b0d3ff9c52a61a89e4e7de4bc3",
"sha256": "702bdee64383069fbea277b2d476d92d65e300d24db64491fd1a299e17041241"
},
"downloads": -1,
"filename": "pylect-0.3.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7df810b0d3ff9c52a61a89e4e7de4bc3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 260940,
"upload_time": "2024-06-03T17:58:06",
"upload_time_iso_8601": "2024-06-03T17:58:06.806554Z",
"url": "https://files.pythonhosted.org/packages/40/41/f78a79784cc001d3ab15b8fbd6278a620e01213c1e28547afb5fd808f2a4/pylect-0.3.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "90722b0b7a44e51988bf836cfccf296e6a372684d625774672b01fe05ee8d314",
"md5": "8ca416f09ac261657005cb6ee1094c4e",
"sha256": "cde9e98186cece44052ae084da5593372fc95f2ab990d4b56206a52b2d8fa7c3"
},
"downloads": -1,
"filename": "pylect-0.3.3.tar.gz",
"has_sig": false,
"md5_digest": "8ca416f09ac261657005cb6ee1094c4e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 258044,
"upload_time": "2024-06-03T17:58:08",
"upload_time_iso_8601": "2024-06-03T17:58:08.778174Z",
"url": "https://files.pythonhosted.org/packages/90/72/2b0b7a44e51988bf836cfccf296e6a372684d625774672b01fe05ee8d314/pylect-0.3.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-03 17:58:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "wtwingate",
"github_project": "pylect",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pylect"
}
