youversion-bible-client 0.1.0__tar.gz

youversion_bible_client-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Taiwo Kareem
+
+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.

youversion_bible_client-0.1.0/PKG-INFO

@@ -0,0 +1,188 @@
+Metadata-Version: 2.4
+Name: youversion-bible-client
+Version: 0.1.0
+Summary: A Command line interface for interacting with the YouVersion Bible API
+License-Expression: MIT
+License-File: LICENSE
+Keywords: YouVersion Bible,Bible,Youversion,Lifechurch
+Author: Taiwo Kareem
+Author-email: taiwo.kareem36@gmail.com
+Maintainer: Taiwo Kareem
+Maintainer-email: taiwo.kareem36@gmail.com
+Requires-Python: >=3.9
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: httpx (>=0.25.0)
+Requires-Dist: pydantic (>=2.5.0)
+Requires-Dist: pyjwt (>=2.10.1)
+Requires-Dist: python-dotenv (>=0.19.0)
+Requires-Dist: typing-extensions (>=4.0.0)
+Project-URL: Homepage, https://github.com/tushortz/youversion-bible-client
+Project-URL: Repository, https://github.com/tushortz/youversion-bible-client
+Description-Content-Type: text/markdown
+
+# YouVersion Bible API Client
+
+This project came about when I was looking to export all my notes from the Youversion Bible app. Please use responsibly.
+
+
+A comprehensive Python client library for accessing the YouVersion Bible API. This library provides both synchronous and asynchronous interfaces to interact with all YouVersion API endpoints.
+
+
+## Installation
+
+```bash
+pip install youversion-bible-client
+```
+
+## Features
+
+- [x] verse of the day
+- [x] moments / feeds
+- [x] notes
+- [x] verse highlights
+- [x] bookmarks
+- [x] plan subscriptions
+- [x] plan progress
+- [x] plan completions
+- [x] verse search
+
+
+## Quick start
+
+### Client
+
+## Examples
+
+### Create sync client
+
+The sync client is a wrapper on top of the asynchronous client. See [DOCS.md](./DOCS.md) on examples on how to use
+
+```py
+from youversion.clients import SyncClient
+
+client = SyncClient()
+
+# get verse of the day
+client.verse_of_the_day()
+```
+
+### creating async client
+
+```py
+import asyncio
+from youversion.clients import AsyncClient
+
+async def main():
+    # Using async context manager (recommended)
+    async with AsyncClient() as client:
+        # Get verse of the day
+        votd = await client.verse_of_the_day()
+```
+
+
+### Verse of the day
+
+```py
+# get's the current day's votd
+result = client.verse_of_the_day()
+
+# get's specified votd
+client.verse_of_the_day(day=365)
+```
+
+### Moments
+
+#### Get moments
+
+Moments fall into different categories such as `bookmark`, `highlight`, `note`, `image`, `badge`, `plan_subscription`, `plan_completion`, `plan_segment_completion`, `friendship`
+
+Moments take optional page parameters. default is page 1
+
+```py
+client.badges()
+client.bookmarks()
+client.friendships()
+client.highlights()
+client.moments()
+client.my_images()
+client.notes()
+client.plan_completions()
+client.plan_progress()
+client.plan_subscriptions()
+```
+
+#### Create a moment
+
+```py
+# Some fields are optional or provide default values.
+# infer those from the method type hints
+# version_id for example kjv = 1
+client.create_moment(
+    {
+        "kind": "note",
+        "content": "My genesis 10:2 note body",
+        "references": [
+            {"human": "genesis 10:2", "version_id": 1, "usfm": ["GEN.10.2"]}
+        ],
+        "title": "My genesis 10:2 note",
+        "status": "private",
+        "body": "My genesis 10:2 note body",
+        "color": "ff0000",
+        "labels": ["test"],
+        "language_tag": "en",
+    }
+)
+```
+
+### Bible
+
+#### Verse search
+
+```py
+client.search_bible("christ died for us")
+```
+
+#### Get bible chapter
+
+```py
+client.get_bible_chapter(reference="GEN.1")
+```
+
+### Bible versions
+
+```py
+client.get_bible_versions()
+
+# you can specify a 3 digit language tag. e.g. ita for italian
+# default is eng (english)
+client.get_bible_versions(language_tag="eng")
+
+# You can also get a single bible version detail
+client.get_bible_version(version_id=1)
+```
+
+### Bible Audio
+
+```py
+# version id defaults to 1 (kjv)
+client.get_audio_chapter(reference="GEN.1")
+client.get_audio_chapter(reference="GEN.1", version_id=1)
+
+# Get audio version details
+client.get_audio_version(audio_id=1)
+```
+
+
+### Friends
+
+#### Send friend request
+
+```py
+client.send_friend_request(user_id=123456789)
+```

youversion_bible_client-0.1.0/README.md

@@ -0,0 +1,160 @@
+# YouVersion Bible API Client
+
+This project came about when I was looking to export all my notes from the Youversion Bible app. Please use responsibly.
+
+
+A comprehensive Python client library for accessing the YouVersion Bible API. This library provides both synchronous and asynchronous interfaces to interact with all YouVersion API endpoints.
+
+
+## Installation
+
+```bash
+pip install youversion-bible-client
+```
+
+## Features
+
+- [x] verse of the day
+- [x] moments / feeds
+- [x] notes
+- [x] verse highlights
+- [x] bookmarks
+- [x] plan subscriptions
+- [x] plan progress
+- [x] plan completions
+- [x] verse search
+
+
+## Quick start
+
+### Client
+
+## Examples
+
+### Create sync client
+
+The sync client is a wrapper on top of the asynchronous client. See [DOCS.md](./DOCS.md) on examples on how to use
+
+```py
+from youversion.clients import SyncClient
+
+client = SyncClient()
+
+# get verse of the day
+client.verse_of_the_day()
+```
+
+### creating async client
+
+```py
+import asyncio
+from youversion.clients import AsyncClient
+
+async def main():
+    # Using async context manager (recommended)
+    async with AsyncClient() as client:
+        # Get verse of the day
+        votd = await client.verse_of_the_day()
+```
+
+
+### Verse of the day
+
+```py
+# get's the current day's votd
+result = client.verse_of_the_day()
+
+# get's specified votd
+client.verse_of_the_day(day=365)
+```
+
+### Moments
+
+#### Get moments
+
+Moments fall into different categories such as `bookmark`, `highlight`, `note`, `image`, `badge`, `plan_subscription`, `plan_completion`, `plan_segment_completion`, `friendship`
+
+Moments take optional page parameters. default is page 1
+
+```py
+client.badges()
+client.bookmarks()
+client.friendships()
+client.highlights()
+client.moments()
+client.my_images()
+client.notes()
+client.plan_completions()
+client.plan_progress()
+client.plan_subscriptions()
+```
+
+#### Create a moment
+
+```py
+# Some fields are optional or provide default values.
+# infer those from the method type hints
+# version_id for example kjv = 1
+client.create_moment(
+    {
+        "kind": "note",
+        "content": "My genesis 10:2 note body",
+        "references": [
+            {"human": "genesis 10:2", "version_id": 1, "usfm": ["GEN.10.2"]}
+        ],
+        "title": "My genesis 10:2 note",
+        "status": "private",
+        "body": "My genesis 10:2 note body",
+        "color": "ff0000",
+        "labels": ["test"],
+        "language_tag": "en",
+    }
+)
+```
+
+### Bible
+
+#### Verse search
+
+```py
+client.search_bible("christ died for us")
+```
+
+#### Get bible chapter
+
+```py
+client.get_bible_chapter(reference="GEN.1")
+```
+
+### Bible versions
+
+```py
+client.get_bible_versions()
+
+# you can specify a 3 digit language tag. e.g. ita for italian
+# default is eng (english)
+client.get_bible_versions(language_tag="eng")
+
+# You can also get a single bible version detail
+client.get_bible_version(version_id=1)
+```
+
+### Bible Audio
+
+```py
+# version id defaults to 1 (kjv)
+client.get_audio_chapter(reference="GEN.1")
+client.get_audio_chapter(reference="GEN.1", version_id=1)
+
+# Get audio version details
+client.get_audio_version(audio_id=1)
+```
+
+
+### Friends
+
+#### Send friend request
+
+```py
+client.send_friend_request(user_id=123456789)
+```

youversion_bible_client-0.1.0/pyproject.toml

@@ -0,0 +1,182 @@
+[project]
+name = "youversion-bible-client"
+version = "0.1.0"
+description = "A Command line interface for interacting with the YouVersion Bible API"
+authors = [
+    {name = "Taiwo Kareem", email = "taiwo.kareem36@gmail.com"}
+]
+maintainers = [
+    {name = "Taiwo Kareem", email = "taiwo.kareem36@gmail.com"}
+]
+license = "MIT"
+readme = "README.md"
+keywords = ["YouVersion Bible", "Bible", "Youversion", "Lifechurch"]
+requires-python = ">=3.9"
+dependencies = [
+    "httpx>=0.25.0",
+    "python-dotenv>=0.19.0",
+    "pydantic>=2.5.0",
+    "pyjwt>=2.10.1",
+    "typing-extensions>=4.0.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/tushortz/youversion-bible-client"
+Repository = "https://github.com/tushortz/youversion-bible-client"
+
+[project.scripts]
+youversion = "youversion.cli:main"
+add-theme = "youversion.cli:poetry_cmd_add_theme"
+badges = "youversion.cli:poetry_cmd_badges"
+bookmarks = "youversion.cli:poetry_cmd_bookmarks"
+convert-notes = "youversion.cli:poetry_cmd_convert_notes"
+create-comment = "youversion.cli:poetry_cmd_create_comment"
+create-moment = "youversion.cli:poetry_cmd_create_moment"
+delete-comment = "youversion.cli:poetry_cmd_delete_comment"
+delete-moment = "youversion.cli:poetry_cmd_delete_moment"
+delete-saved-event = "youversion.cli:poetry_cmd_delete_saved_event"
+get-all-saved-event-ids = "youversion.cli:poetry_cmd_get_all_saved_event_ids"
+get-audio-chapter = "youversion.cli:poetry_cmd_get_audio_chapter"
+get-audio-version = "youversion.cli:poetry_cmd_get_audio_version"
+get-bible-chapter = "youversion.cli:poetry_cmd_get_bible_chapter"
+get-bible-configuration = "youversion.cli:poetry_cmd_get_bible_configuration"
+get-bible-version = "youversion.cli:poetry_cmd_get_bible_version"
+get-bible-versions = "youversion.cli:poetry_cmd_get_bible_versions"
+get-event-configuration = "youversion.cli:poetry_cmd_get_event_configuration"
+get-event-details = "youversion.cli:poetry_cmd_get_event_details"
+get-image-upload-url = "youversion.cli:poetry_cmd_get_image_upload_url"
+get-images = "youversion.cli:poetry_cmd_get_images"
+get-localization-items = "youversion.cli:poetry_cmd_get_localization_items"
+get-moment-colors = "youversion.cli:poetry_cmd_get_moment_colors"
+get-moment-details = "youversion.cli:poetry_cmd_get_moment_details"
+get-moment-labels = "youversion.cli:poetry_cmd_get_moment_labels"
+get-moments = "youversion.cli:poetry_cmd_get_moments"
+get-moments-configuration = "youversion.cli:poetry_cmd_get_moments_configuration"
+get-recommended-languages = "youversion.cli:poetry_cmd_get_recommended_languages"
+get-saved-events = "youversion.cli:poetry_cmd_get_saved_events"
+get-theme-description = "youversion.cli:poetry_cmd_get_theme_description"
+get-themes = "youversion.cli:poetry_cmd_get_themes"
+get-verse-colors = "youversion.cli:poetry_cmd_get_verse_colors"
+get-video-details = "youversion.cli:poetry_cmd_get_video_details"
+get-videos = "youversion.cli:poetry_cmd_get_videos"
+hide-verse-colors = "youversion.cli:poetry_cmd_hide_verse_colors"
+highlights = "youversion.cli:poetry_cmd_highlights"
+images = "youversion.cli:poetry_cmd_images"
+like-moment = "youversion.cli:poetry_cmd_like_moment"
+moments = "youversion.cli:poetry_cmd_moments"
+notes = "youversion.cli:poetry_cmd_notes"
+plan-completions = "youversion.cli:poetry_cmd_plan_completions"
+plan-progress = "youversion.cli:poetry_cmd_plan_progress"
+plan-subscriptions = "youversion.cli:poetry_cmd_plan_subscriptions"
+register-device = "youversion.cli:poetry_cmd_register_device"
+remove-theme = "youversion.cli:poetry_cmd_remove_theme"
+save-event = "youversion.cli:poetry_cmd_save_event"
+search-bible = "youversion.cli:poetry_cmd_search_bible"
+search-events = "youversion.cli:poetry_cmd_search_events"
+search-plans = "youversion.cli:poetry_cmd_search_plans"
+search-users = "youversion.cli:poetry_cmd_search_users"
+send-friend-request = "youversion.cli:poetry_cmd_send_friend_request"
+set-theme = "youversion.cli:poetry_cmd_set_theme"
+unlike-moment = "youversion.cli:poetry_cmd_unlike_moment"
+unregister-device = "youversion.cli:poetry_cmd_unregister_device"
+update-moment = "youversion.cli:poetry_cmd_update_moment"
+votd = "youversion.cli:poetry_cmd_votd"
+
+[tool.poetry]
+packages = [{ include = "youversion" }]
+exclude = [
+    "documentation/**/*",
+    "documentation",
+    "examples/**/*",
+    "examples",
+    "tests/**/*",
+    "tests",
+    "htmlcov/**/*",
+    "htmlcov",
+    "env/**/*",
+    "env",
+    "*.pyc",
+    "__pycache__/**/*",
+    "*.egg-info",
+    ".pytest_cache/**/*",
+    ".mypy_cache/**/*",
+    "bandit-report.json",
+    "main.py",
+    "note_to_markdown.py",
+    "run_tests.py",
+]
+
+[tool.poetry.group.dev.dependencies]
+pytest = "^8.2.0"
+pytest-cov = "^4.0.0"
+pytest-asyncio = "^0.21.0"
+black = "^23.0.0"
+ruff = "^0.1.0"
+sphinx = "^7.4.0"
+sphinx-rtd-theme = "^3.0.0"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+
+[tool.black]
+line-length = 88
+target-version = ['py39']
+include = '\.pyi?$'
+extend-exclude = '''
+/(
+  # directories
+  \.eggs
+  | \.git
+  | \.hg
+  | \.mypy_cache
+  | \.tox
+  | \.venv
+  | build
+  | dist
+)/
+'''
+
+[tool.ruff]
+target-version = "py39"
+line-length = 88
+select = [
+  "E",  # pycodestyle errors
+  "W",  # pycodestyle warnings
+  "F",  # pyflakes
+  "I",  # isort
+  "B",  # flake8-bugbear
+  "C4", # flake8-comprehensions
+  "UP", # pyupgrade
+]
+ignore = [
+  "E501", # line too long, handled by black
+  "B008", # do not perform function calls in argument defaults
+  "C901", # too complex
+]
+
+[tool.ruff.per-file-ignores]
+"__init__.py" = ["F401"]
+
+[tool.ruff.isort]
+known-first-party = ["youversion"]
+
+[tool.coverage.run]
+source = ["youversion"]
+omit = [
+    "youversion/cli.py",
+    "*/tests/*",
+    "*/test_*.py",
+]
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "def __repr__",
+    "raise AssertionError",
+    "raise NotImplementedError",
+    "if __name__ == .__main__.:",
+    "if TYPE_CHECKING:",
+    "@abstractmethod",
+]

youversion_bible_client-0.1.0/youversion/__init__.py

@@ -0,0 +1,34 @@
+"""YouVersion Bible Client Library
+
+A Python client library for accessing the YouVersion Bible API.
+Supports both synchronous and asynchronous operations.
+
+Example usage:
+
+Synchronous:
+    from youversion import SyncClient
+
+    with SyncClient() as client:
+        votd = client.verse_of_the_day()
+        print(votd)
+
+Asynchronous:
+    import asyncio
+    from youversion import AsyncClient
+
+    async def main():
+        async with AsyncClient() as client:
+            votd = await client.verse_of_the_day()
+            print(votd)
+
+    asyncio.run(main())
+"""
+
+from .clients import AsyncClient, SyncClient
+
+# Backward compatibility aliases
+AClient = AsyncClient
+Client = SyncClient
+
+__version__ = "0.3.0"
+__all__ = ["AsyncClient", "SyncClient", "AClient", "Client"]