djangobible 0.1.1__py3-none-any.whl → 0.3.0__py3-none-any.whl

djangobible/__init__.py

@@ -1,5 +1,4 @@
-"""
-djangobible python library.
+"""djangobible python library.
 
 djangobible lets you easily associate Django models with Bible Scripture references and
 search accordingly.
@@ -7,6 +6,6 @@ search accordingly.
 
 from __future__ import annotations
 
-__version__ = "0.1.1"
+__version__ = "0.3.0"
 
 from pythonbible import *

djangobible/fields.py

@@ -2,7 +2,8 @@
 
 from __future__ import annotations
 
-from typing import Any, Callable
+from typing import Any
+from typing import Callable
 
 import pythonbible as bible
 from django import forms
@@ -24,7 +25,8 @@ class VerseField(models.Field):
                 bible.get_references(value),
             )[0]
         elif isinstance(value, int) and not bible.is_valid_verse_id(value):
-            raise ValidationError(f"{value} is not a valid verse id.")
+            error_message = f"{value} is not a valid verse id."
+            raise ValidationError(error_message)
 
         return super().get_prep_value(value)
 
@@ -56,8 +58,8 @@ class VerseField(models.Field):
 
     def formfield(
         self: VerseField,
-        form_class: Any = None,
-        choices_form_class: Any = None,
+        form_class: type[forms.Field] | None = None,
+        choices_form_class: type[forms.Field] | None = None,
         **kwargs: Any,
     ) -> forms.Field:
         """Make sure the form field is a CharField."""
@@ -70,7 +72,7 @@ class VerseField(models.Field):
 
     def get_db_prep_save(
         self: VerseField,
-        value: Any,
+        value: int | str | None,
         **kwargs: Any,
     ) -> int | None:
         """Validate and convert the value to a verse id int before saving to the DB."""
@@ -83,12 +85,12 @@ class VerseField(models.Field):
             if verse_ids := bible.convert_references_to_verse_ids(references):
                 value = verse_ids[0]
             else:
-                raise ValidationError(
-                    f"{value} does not contain a valid Scripture reference.",
-                )
+                error_message = f"{value} does not contain a valid Scripture reference."
+                raise ValidationError(error_message)
 
         if not bible.is_valid_verse_id(value):
-            raise ValidationError(f"{value} is not a valid verse id.")
+            error_message = f"{value} is not a valid verse id."
+            raise ValidationError(error_message)
 
         return int(value)
 

djangobible/models.py

@@ -2,10 +2,9 @@
 
 from __future__ import annotations
 
-from typing import Any
-
 import pythonbible as bible
-from django.contrib.contenttypes.fields import GenericForeignKey, GenericRelation
+from django.contrib.contenttypes.fields import GenericForeignKey
+from django.contrib.contenttypes.fields import GenericRelation
 from django.contrib.contenttypes.models import ContentType
 from django.db import models
 
@@ -29,8 +28,8 @@ class VerseRelation(models.Model):
         self: VerseRelation,
         force_insert: bool = False,
         force_update: bool = False,
-        using: Any = None,
-        update_fields: Any = None,
+        using: str | None = None,
+        update_fields: list[str] | None = None,
     ) -> None:
         """Save the instance to the DB."""
         if not bible.is_valid_verse_id(self.verse):
@@ -45,7 +44,7 @@ class ScriptureIndexedModelManager(models.Manager):
     def filter_by_verse_ids(
         self: ScriptureIndexedModelManager,
         verse_ids: list[int] | None,
-    ) -> Any:
+    ) -> models.QuerySet:
         """Return the Query Set for the objects related to the given verse ids."""
         content_type = ContentType.objects.get_for_model(self.model)
         verse_relations = VerseRelation.objects.filter(

djangobible/templatetags/verse_tags.py

@@ -13,8 +13,7 @@ register = template.Library()
 
 @register.simple_tag
 def verse_reference(verse_id: int, **kwargs: Any) -> str:
-    """
-    For a given verse id return the formatted scripture reference string.
+    """For a given verse id return the formatted scripture reference string.
 
     :param verse_id:
     :return: the scripture reference string for the given verse id
@@ -25,7 +24,7 @@ def verse_reference(verse_id: int, **kwargs: Any) -> str:
     book, chapter, verse = bible.get_book_chapter_verse(verse_id)
 
     if version_id := kwargs.get("version"):
-        kwargs["version"] = _get_version(version_id)
+        kwargs["version"] = _get_version(version_id)  # type: ignore[arg-type,assignment]
 
     reference = bible.NormalizedReference(book, chapter, verse, chapter, verse)
 
@@ -34,19 +33,18 @@ def verse_reference(verse_id: int, **kwargs: Any) -> str:
 
 @register.simple_tag
 def verse_text(verse_id: int, **kwargs: Any) -> str:
-    """
-    For a given verse id and version, return the verse text string.
+    """For a given verse id and version, return the verse text string.
 
     :param verse_id:
     :return: the verse text for the given verse id and version
     """
-    version_id: str | None = kwargs.get("version")
+    version_id: str | None = kwargs.get("version")  # type: ignore[assignment]
     text: str = (
         bible.get_verse_text(verse_id, _get_version(version_id))
         if version_id
         else bible.get_verse_text(verse_id)
     )
-    include_verse_numbers: bool = kwargs.get("include_verse_numbers", False)
+    include_verse_numbers: bool = kwargs.get("include_verse_numbers", False)  # type: ignore[assignment]
 
     return (
         f"{bible.get_verse_number(verse_id)}. {text}" if include_verse_numbers else text

djangobible/validators.py

@@ -3,11 +3,9 @@
 from __future__ import annotations
 
 from django.core.exceptions import ValidationError
-from pythonbible import (
-    NormalizedReference,
-    convert_references_to_verse_ids,
-    get_references,
-)
+from pythonbible import NormalizedReference
+from pythonbible import convert_references_to_verse_ids
+from pythonbible import get_references
 
 
 def validate_verse(verse_value: str | None) -> None:
@@ -18,12 +16,15 @@ def validate_verse(verse_value: str | None) -> None:
     references: list[NormalizedReference] = get_references(verse_value)
 
     if not references:
-        raise ValidationError("Not a valid reference.")
+        error_message = "Not a valid reference."
+        raise ValidationError(error_message)
 
     if len(references) > 1:
-        raise ValidationError("Only single verse references allowed.")
+        error_message = "Only single verse references allowed."
+        raise ValidationError(error_message)
 
     verse_ids: list[int] = convert_references_to_verse_ids(references)
 
     if len(verse_ids) > 1:
-        raise ValidationError("Only single verse references allowed.")
+        error_message = "Only single verse references allowed."
+        raise ValidationError(error_message)

{djangobible-0.1.1.dist-info → djangobible-0.3.0.dist-info}/METADATA

@@ -1,24 +1,30 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: djangobible
-Version: 0.1.1
-Summary: djangobible python library.
-Home-page: https://github.com/avendesora/djangobible
+Version: 0.3.0
 Author: Nathan Patton
-Author-email: npatton@gmail.com
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
+Author-email: Nathan Patton <npatton@gmail.com>
+License-Expression: MIT
+Classifier: Framework :: Django
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+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
 Classifier: License :: OSI Approved :: MIT License
-Requires-Dist: Django >=3.2.0
-Requires-Dist: pythonbible >=0.11.1
-Requires-Dist: defusedxml >=0.7.1 ; extra == "all"
-Requires-Dist: pre-commit >=2.20.0 ; extra == "dev"
-Requires-Dist: coverage >=6.4.2 ; extra == "test"
-Requires-Dist: factory-boy >=3.2.1 ; extra == "test"
-Requires-Dist: playwright >=1.23.1 ; extra == "test"
-Provides-Extra: all
-Provides-Extra: dev
-Provides-Extra: doc
-Provides-Extra: test
+Requires-Dist: django>=4.2.0
+Requires-Dist: pythonbible==0.14.0
+Requires-Python: >=3.10
+Project-URL: Source, https://github.com/avendesora/djangobible
+Description-Content-Type: text/markdown
 
 # djangobible
 
@@ -39,8 +45,9 @@ The djangobible library is a Django app that wraps the [pythonbible](https://git
     <tr>
         <td>Tests</td>
         <td>
-            <img src="https://github.com/avendesora/djangobible/workflows/Django%20CI/badge.svg">
-            <a href="https://www.codacy.com/gh/avendesora/djangobible/dashboard?utm_source=github.com&utm_medium=referral&utm_content=avendesora/djangobible&utm_campaign=Badge_Coverage"><img src="https://app.codacy.com/project/badge/Coverage/83a28131bf6642ed9e439344122686fc"></a>
+            <img src="https://github.com/avendesora/djangobible/actions/workflows/tests.yml/badge.svg">
+            <img src="https://github.com/avendesora/djangobible/workflows/Django%20CI/badge.svg"><br/>
+            <a href="https://app.codacy.com/gh/avendesora/djangobible/coverage/dashboard"><img src="https://app.codacy.com/project/badge/Coverage/83a28131bf6642ed9e439344122686fc"></a>
         </td>
     </tr>
     <tr>
@@ -55,8 +62,8 @@ The djangobible library is a Django app that wraps the [pythonbible](https://git
     <tr>
         <td>Supported Python/Django Versions</td>
         <td>
-            <a href="https://www.python.org/downloads/"><img src="https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11-blue?logo=python&logoColor=lightgray"></a><br />
-            <a href="https://www.djangoproject.com/download/"><img src="https://img.shields.io/badge/Django-3.2%20%7C%204.0%20%7C%204.1%20%7C%204.2-blue"></a>
+            <a href="https://www.python.org/downloads/"><img src="https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12%20%7C%203.13%20%7C%203.14-blue?logo=python&logoColor=lightgray"></a><br />
+            <a href="https://www.djangoproject.com/download/"><img src="https://img.shields.io/badge/Django-4.2%20%7C%205.0%20%7C%205.1%20%7C%205.2-blue"></a><br />
         </td>
     </tr>
 </table>
@@ -261,4 +268,3 @@ Then you could add, remove, and reference those verses with something like:
 ```
 
 Ideally, the form field would be a text field where the user could enter a list of Scripture references (e.g. "Genesis 1:1,3-10;Psalm 119;Luke 2:1-18;John 3:16")
-

djangobible-0.3.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+djangobible/__init__.py,sha256=y0MkH-8--IsNMjbM6ftQqFHZA7J9R-Z0NXc07iRKURI,230
+djangobible/apps.py,sha256=lJgCh5Hj0i-nuTS_1s9HmwMNgVX-i1nFEIJkVsUbOfs,244
+djangobible/fields.py,sha256=i8KYKQY1K6ZJm2FSFmirutwBWM5Xfbtnp7pDC8dLUFw,3189
+djangobible/migrations/0001_initial.py,sha256=5lNyBJtwuZSchhDbxeIfiWGPcf308PGl0Mc5uCxI5c0,1200
+djangobible/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+djangobible/models.py,sha256=qDCKczj9nOYauVErkae14gfRaZSs0R-1mzuN3q5KD9E,3082
+djangobible/templatetags/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+djangobible/templatetags/verse_tags.py,sha256=xL-ZWOugyBKM1UyfLb7Hm3RD98Quu8_PhoAHV3UueGg,1811
+djangobible/validators.py,sha256=nAtbb7Epwehd8oZ7ATSWKTcKCHklZZXYGlmLoUq7gow,996
+djangobible-0.3.0.dist-info/WHEEL,sha256=eh7sammvW2TypMMMGKgsM83HyA_3qQ5Lgg3ynoecH3M,79
+djangobible-0.3.0.dist-info/METADATA,sha256=tBriLOnfPvHh6XF-mw0Nvh_LhgCQUQ3hQ3Wwa0u2quU,10306
+djangobible-0.3.0.dist-info/RECORD,,

{djangobible-0.1.1.dist-info → djangobible-0.3.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: flit 3.8.0
+Generator: uv 0.8.24
 Root-Is-Purelib: true
-Tag: py3-none-any
+Tag: py3-none-any

djangobible-0.1.1.dist-info/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2020 Nathan Patton
-
-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.

djangobible-0.1.1.dist-info/RECORD

@@ -1,13 +0,0 @@
-djangobible/__init__.py,sha256=CZeKMO0N7WX92yJJRrcXxL_Vogcwva9d6WNT4f7xfZw,231
-djangobible/apps.py,sha256=lJgCh5Hj0i-nuTS_1s9HmwMNgVX-i1nFEIJkVsUbOfs,244
-djangobible/fields.py,sha256=dgACjzISLSHiP2O6W2EGkmeexq3l6NbJKGnuUMsxhVQ,3025
-djangobible/models.py,sha256=lDrU0RKwV8DDy2SrNky6Owrh73Rri6ud1Dm99ipapUs,3028
-djangobible/validators.py,sha256=MWMWUbiZLQsOp69Fy-V1z2Ly3qyGWWPLRjgG6RhU1BA,853
-djangobible/migrations/0001_initial.py,sha256=5lNyBJtwuZSchhDbxeIfiWGPcf308PGl0Mc5uCxI5c0,1200
-djangobible/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-djangobible/templatetags/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-djangobible/templatetags/verse_tags.py,sha256=EmakxtAaXulVPpC9Rz3S49snWxlPdDX1vUiT0ZvqpXk,1728
-djangobible-0.1.1.dist-info/LICENSE,sha256=vtcKfpmHsOwjUi3axlhP7KzGGZE6OmG7cigMXbLK8xU,1070
-djangobible-0.1.1.dist-info/WHEEL,sha256=rSgq_JpHF9fHR1lx53qwg_1-2LypZE_qmcuXbVUq948,81
-djangobible-0.1.1.dist-info/METADATA,sha256=m8DjoaNMRGJ1yKE7YKlmHmNWO7C81Bydup4xv52HNd4,9850
-djangobible-0.1.1.dist-info/RECORD,,