djangobible 0.0.13__tar.gz → 0.3.0__tar.gz

djangobible-0.3.0/PKG-INFO

@@ -0,0 +1,270 @@
+Metadata-Version: 2.4
+Name: djangobible
+Version: 0.3.0
+Author: Nathan Patton
+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>=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
+
+The djangobible library is a Django app that wraps the [pythonbible](https://github.com/avendesora/pythonbible) library and provides models, managers, and other tools to easily index an object by a scripture reference.
+
+<table>
+    <tr>
+        <td>Latest Version</td>
+        <td>
+            <a href="https://pypi.org/project/djangobible/"><img src="https://img.shields.io/pypi/v/djangobible?color=gold&logo=pypi&logoColor=lightgray"></a>
+            <img src="https://img.shields.io/pypi/dm/djangobible?color=gold">
+        </td>
+    </tr>
+    <tr>
+        <td>License</td>
+        <td><a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/license-MIT-orange.svg"></a></td>
+    </tr>
+    <tr>
+        <td>Tests</td>
+        <td>
+            <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>
+        <td>Code Quality</td>
+        <td>
+            <img src="https://github.com/avendesora/djangobible/workflows/CodeQL/badge.svg">
+            <a href="https://app.codacy.com/gh/avendesora/djangobible?utm_source=github.com&utm_medium=referral&utm_content=avendesora/djangobible&utm_campaign=Badge_Grade_Settings"><img src="https://api.codacy.com/project/badge/Grade/ca34603bdaf8446ba288430b69092093"></a><br/>
+            <a href="https://results.pre-commit.ci/latest/github/avendesora/djangobible/main"><img src="https://results.pre-commit.ci/badge/github/avendesora/djangobible/main.svg"></a>
+            <a href="https://github.com/psf/black"><img src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
+        </td>
+    </tr>
+    <tr>
+        <td>Supported Python/Django Versions</td>
+        <td>
+            <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>
+
+## Installation
+
+Pip install the djangobible library.
+
+```shell script
+pip install djangobible
+```
+
+Add djangobible to your Django project's ``INSTALLED_APPS`` setting:
+
+```python
+INSTALLED_APPS = [
+    ...,  # other apps
+    "djangobible",
+]
+```
+
+Run the django migrations for djangobible
+
+```shell script
+./manage.py migrate djangobible
+```
+
+### Settings
+
+There currently are no settings (other than INSTALLED_APPS) related to the djangobible project. In the future, it would be nice to have settings that determine things like the available versions of the Bible and the default version.
+
+Also, once support is implemented for multiple locales and languages, there could be related settings for that functionality.
+
+## Features
+
+The djangobible library is a complete wrapper for the [pythonbible](https://github.com/avendesora/pythonbible) library, so importing the djangobible library as:
+
+```python
+import djangobible as bible
+```
+
+will provide all the same functionality as importing the pythonbible library as:
+
+```python
+import pythonbible as bible
+```
+
+This includes features such as:
+- Searching text for Scripture references
+- Converting a normalized scripture reference into a list of integer verse ids
+- Converting a list of verse id integers into a list of normalized scripture references
+- Converting a list of normalized scripture references into a formatted string scripture reference
+- Retrieving the Biblical text (in one or more open-source or public domain versions) for a given verse ID integer
+
+For more information, see the [pythonbible documentation](https://github.com/avendesora/pythonbible).
+
+In addition, the djangobible library includes the following features:
+
+### Template Tags
+
+There are currently two template tags provided by the djangobible library: ``verse_reference`` and ``verse_text``.
+
+#### verse_reference
+
+The ``verse_reference`` template tag, given a verse ID and a Bible version, returns the appropriate Scripture reference string.
+
+For example, given ``verse_id = 1001001`` and ``version = djangobible.Version.KING_JAMES``, the following snippet from a Django template:
+
+```html
+{% load verse_tags %}
+...
+{% verse_reference verse_id version=version %}
+```
+
+would display:
+
+```
+Genesis 1:1
+```
+
+The version parameter is optional, and the current default is King James, though that will ideally be configurable in the future.
+
+There is another optional parameter, ``full_title``, which is a boolean flag to determine whether to display the long version or the short version of the book of the Bible title. It defaults to ``False``, which displays the short version. For example, given ``verse_id = 1001001`` and ``version = djangobible.Version.KING_JAMES`` and ``full_title = True``, the following snippet from a Django template:
+
+```html
+{% load verse_tags %}
+...
+{% verse_reference verse_id version=version full_title=full_title %}
+```
+
+would display:
+
+```
+The First Book of Moses, called Genesis 1:1
+```
+
+#### verse_text
+
+The ``verse_text`` template tag, given a verse ID and a Bible version, returns the appropriate text of that Bible verse.
+
+For example, given ``verse_id = 1001001`` and ``version = djangobible.Version.KING_JAMES``, the following snippet from a Django template:
+
+```html
+{% load verse_tags %}
+...
+{% verse_text verse_id %}
+```
+
+would display:
+
+```
+In the beginning God created the heaven and the earth.
+```
+
+The version parameter is optional, and the current default is King James, though that will ideally be configurable in the future.
+
+### One-to-many style relationships between verses and Django models
+
+For situations where an instance of a Django model needs to be associated with a single verse, that Django model can have a field of type ``VerseField``.
+
+For example:
+
+```python
+from django.db import models
+
+import djangobible as bible
+
+
+class MyModel(models.Model):
+    ...  # other fields
+
+    verse = bible.VerseField()
+```
+
+The underlying implementation of ``VerseField`` is an ``IntegerField`` which stores the verse ID of the associated verse.
+
+Having this custom field type provides several benefits:
+- The Django admin (and Wagtail) form contains a text field for the verse rather than an integer field and allows the user to enter the Scripture reference text rather than the verse id, which they may not know. It then validates that text to ensure it references one, and only one, verse.
+- As just mentioned, this allows for validation, not only that the value is one, and only one, verse id, but that it is also a valid verse id (i.e. that it represents a book, chapter, and verse of the Bible that actually exists).
+- More readable query filters (e.g. ``MyModel.objects.filter(verse=1001001)`` is valid, but so is ``MyModel.objects.filter(verse="Genesis 1:1")``).
+
+You can set the verse field with either the int verse ID or the string reference:
+
+```python
+my_object = MyModel.objects.create(name="my object")
+my_object.verse = 1001001
+my_object.save()
+```
+
+or
+
+```python
+my_object = MyModel.objects.create(name="my object")
+my_object.verse = "Genesis 1:1"
+my_object.save()
+```
+
+You can filter the objects in the query set by either the int verse ID or the string reference:
+
+```python
+MyModel.objects.filter(verse=1001001)
+```
+
+or
+
+```python
+MyModel.objects.filter(verse="Genesis 1:1")
+```
+
+In any of the above examples, if the verse is not a valid verse ID integer or string reference for a single verse, then a ``ValidationError`` will be raised.
+
+### Many-to-many style relationships between verses and Django models
+
+> **WARNING**: This is still a work in progress, and this functionality does not yet exist in a stable form.
+
+There are situations where an instance of a Django model needs to be associated with multiple verses. The current intended solution, inspired by the [django-taggit](https://github.com/jazzband/django-taggit) library, is to implement this feature in such a way that you would add this relationship to your model like:
+
+```python
+from django.db import models
+
+import djangobible as bible
+
+
+class MyModel(models.Model):
+    ...  # other fields
+
+    verses = bible.VerseManager()
+```
+
+Then you could add, remove, and reference those verses with something like:
+
+```
+>>> my_object = MyModel.objects.create(name="My Object")
+>>> my_object.verses.add("Genesis 1:1-3")
+>>> my_object.verses.all()
+[<Verse: Genesis 1:1>, <Verse: Genesis 1:2>, <Verse: Genesis 1:3>]
+>>> my_object.verses.remove("Genesis 1:2")
+>>> my_object.verses.all()
+[<Verse: Genesis 1:1>, <Verse: Genesis 1:3>]
+>>> MyModel.objects.filter(verses__in=[1001001])
+[<MyModel: My Object>]
+```
+
+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/README.md

@@ -0,0 +1,242 @@
+# djangobible
+
+The djangobible library is a Django app that wraps the [pythonbible](https://github.com/avendesora/pythonbible) library and provides models, managers, and other tools to easily index an object by a scripture reference.
+
+<table>
+    <tr>
+        <td>Latest Version</td>
+        <td>
+            <a href="https://pypi.org/project/djangobible/"><img src="https://img.shields.io/pypi/v/djangobible?color=gold&logo=pypi&logoColor=lightgray"></a>
+            <img src="https://img.shields.io/pypi/dm/djangobible?color=gold">
+        </td>
+    </tr>
+    <tr>
+        <td>License</td>
+        <td><a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/license-MIT-orange.svg"></a></td>
+    </tr>
+    <tr>
+        <td>Tests</td>
+        <td>
+            <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>
+        <td>Code Quality</td>
+        <td>
+            <img src="https://github.com/avendesora/djangobible/workflows/CodeQL/badge.svg">
+            <a href="https://app.codacy.com/gh/avendesora/djangobible?utm_source=github.com&utm_medium=referral&utm_content=avendesora/djangobible&utm_campaign=Badge_Grade_Settings"><img src="https://api.codacy.com/project/badge/Grade/ca34603bdaf8446ba288430b69092093"></a><br/>
+            <a href="https://results.pre-commit.ci/latest/github/avendesora/djangobible/main"><img src="https://results.pre-commit.ci/badge/github/avendesora/djangobible/main.svg"></a>
+            <a href="https://github.com/psf/black"><img src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
+        </td>
+    </tr>
+    <tr>
+        <td>Supported Python/Django Versions</td>
+        <td>
+            <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>
+
+## Installation
+
+Pip install the djangobible library.
+
+```shell script
+pip install djangobible
+```
+
+Add djangobible to your Django project's ``INSTALLED_APPS`` setting:
+
+```python
+INSTALLED_APPS = [
+    ...,  # other apps
+    "djangobible",
+]
+```
+
+Run the django migrations for djangobible
+
+```shell script
+./manage.py migrate djangobible
+```
+
+### Settings
+
+There currently are no settings (other than INSTALLED_APPS) related to the djangobible project. In the future, it would be nice to have settings that determine things like the available versions of the Bible and the default version.
+
+Also, once support is implemented for multiple locales and languages, there could be related settings for that functionality.
+
+## Features
+
+The djangobible library is a complete wrapper for the [pythonbible](https://github.com/avendesora/pythonbible) library, so importing the djangobible library as:
+
+```python
+import djangobible as bible
+```
+
+will provide all the same functionality as importing the pythonbible library as:
+
+```python
+import pythonbible as bible
+```
+
+This includes features such as:
+- Searching text for Scripture references
+- Converting a normalized scripture reference into a list of integer verse ids
+- Converting a list of verse id integers into a list of normalized scripture references
+- Converting a list of normalized scripture references into a formatted string scripture reference
+- Retrieving the Biblical text (in one or more open-source or public domain versions) for a given verse ID integer
+
+For more information, see the [pythonbible documentation](https://github.com/avendesora/pythonbible).
+
+In addition, the djangobible library includes the following features:
+
+### Template Tags
+
+There are currently two template tags provided by the djangobible library: ``verse_reference`` and ``verse_text``.
+
+#### verse_reference
+
+The ``verse_reference`` template tag, given a verse ID and a Bible version, returns the appropriate Scripture reference string.
+
+For example, given ``verse_id = 1001001`` and ``version = djangobible.Version.KING_JAMES``, the following snippet from a Django template:
+
+```html
+{% load verse_tags %}
+...
+{% verse_reference verse_id version=version %}
+```
+
+would display:
+
+```
+Genesis 1:1
+```
+
+The version parameter is optional, and the current default is King James, though that will ideally be configurable in the future.
+
+There is another optional parameter, ``full_title``, which is a boolean flag to determine whether to display the long version or the short version of the book of the Bible title. It defaults to ``False``, which displays the short version. For example, given ``verse_id = 1001001`` and ``version = djangobible.Version.KING_JAMES`` and ``full_title = True``, the following snippet from a Django template:
+
+```html
+{% load verse_tags %}
+...
+{% verse_reference verse_id version=version full_title=full_title %}
+```
+
+would display:
+
+```
+The First Book of Moses, called Genesis 1:1
+```
+
+#### verse_text
+
+The ``verse_text`` template tag, given a verse ID and a Bible version, returns the appropriate text of that Bible verse.
+
+For example, given ``verse_id = 1001001`` and ``version = djangobible.Version.KING_JAMES``, the following snippet from a Django template:
+
+```html
+{% load verse_tags %}
+...
+{% verse_text verse_id %}
+```
+
+would display:
+
+```
+In the beginning God created the heaven and the earth.
+```
+
+The version parameter is optional, and the current default is King James, though that will ideally be configurable in the future.
+
+### One-to-many style relationships between verses and Django models
+
+For situations where an instance of a Django model needs to be associated with a single verse, that Django model can have a field of type ``VerseField``.
+
+For example:
+
+```python
+from django.db import models
+
+import djangobible as bible
+
+
+class MyModel(models.Model):
+    ...  # other fields
+
+    verse = bible.VerseField()
+```
+
+The underlying implementation of ``VerseField`` is an ``IntegerField`` which stores the verse ID of the associated verse.
+
+Having this custom field type provides several benefits:
+- The Django admin (and Wagtail) form contains a text field for the verse rather than an integer field and allows the user to enter the Scripture reference text rather than the verse id, which they may not know. It then validates that text to ensure it references one, and only one, verse.
+- As just mentioned, this allows for validation, not only that the value is one, and only one, verse id, but that it is also a valid verse id (i.e. that it represents a book, chapter, and verse of the Bible that actually exists).
+- More readable query filters (e.g. ``MyModel.objects.filter(verse=1001001)`` is valid, but so is ``MyModel.objects.filter(verse="Genesis 1:1")``).
+
+You can set the verse field with either the int verse ID or the string reference:
+
+```python
+my_object = MyModel.objects.create(name="my object")
+my_object.verse = 1001001
+my_object.save()
+```
+
+or
+
+```python
+my_object = MyModel.objects.create(name="my object")
+my_object.verse = "Genesis 1:1"
+my_object.save()
+```
+
+You can filter the objects in the query set by either the int verse ID or the string reference:
+
+```python
+MyModel.objects.filter(verse=1001001)
+```
+
+or
+
+```python
+MyModel.objects.filter(verse="Genesis 1:1")
+```
+
+In any of the above examples, if the verse is not a valid verse ID integer or string reference for a single verse, then a ``ValidationError`` will be raised.
+
+### Many-to-many style relationships between verses and Django models
+
+> **WARNING**: This is still a work in progress, and this functionality does not yet exist in a stable form.
+
+There are situations where an instance of a Django model needs to be associated with multiple verses. The current intended solution, inspired by the [django-taggit](https://github.com/jazzband/django-taggit) library, is to implement this feature in such a way that you would add this relationship to your model like:
+
+```python
+from django.db import models
+
+import djangobible as bible
+
+
+class MyModel(models.Model):
+    ...  # other fields
+
+    verses = bible.VerseManager()
+```
+
+Then you could add, remove, and reference those verses with something like:
+
+```
+>>> my_object = MyModel.objects.create(name="My Object")
+>>> my_object.verses.add("Genesis 1:1-3")
+>>> my_object.verses.all()
+[<Verse: Genesis 1:1>, <Verse: Genesis 1:2>, <Verse: Genesis 1:3>]
+>>> my_object.verses.remove("Genesis 1:2")
+>>> my_object.verses.all()
+[<Verse: Genesis 1:1>, <Verse: Genesis 1:3>]
+>>> MyModel.objects.filter(verses__in=[1001001])
+[<MyModel: My Object>]
+```
+
+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/djangobible/__init__.py

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

djangobible-0.3.0/djangobible/apps.py

@@ -0,0 +1,11 @@
+"""The app config for the djangobible library."""
+
+from __future__ import annotations
+
+from django.apps import AppConfig
+
+
+class DjangoBibleConfig(AppConfig):
+    """The app config for the djangobible library."""
+
+    name: str = "djangobible"

djangobible-0.3.0/djangobible/fields.py

@@ -0,0 +1,99 @@
+"""Custom Django model fields for djangobible."""
+
+from __future__ import annotations
+
+from typing import Any
+from typing import Callable
+
+import pythonbible as bible
+from django import forms
+from django.core.exceptions import ValidationError
+from django.db import models
+from django.utils.functional import cached_property
+
+from djangobible.validators import validate_verse
+
+
+class VerseField(models.Field):
+    """Custom Django model field to represent a Verse."""
+
+    def get_prep_value(self: VerseField, value: int | str | None) -> int:
+        """Validate and convert the value to a verse id int."""
+        if isinstance(value, str):
+            validate_verse(value)
+            value = bible.convert_references_to_verse_ids(
+                bible.get_references(value),
+            )[0]
+        elif isinstance(value, int) and not bible.is_valid_verse_id(value):
+            error_message = f"{value} is not a valid verse id."
+            raise ValidationError(error_message)
+
+        return super().get_prep_value(value)
+
+    @cached_property
+    def validators(self: VerseField) -> list[Callable]:
+        """Return the list of validators for this field."""
+        return [validate_verse]
+
+    def to_python(
+        self: VerseField,
+        value: int | str | None,
+    ) -> str | None:
+        """Convert the value into a text scripture reference."""
+        if value is None or isinstance(value, str):
+            return value
+
+        return bible.format_scripture_references(
+            bible.convert_verse_ids_to_references([value]),
+        )
+
+    def from_db_value(
+        self: VerseField,
+        value: int | str | None,
+        expression: Any,
+        connection: Any,
+    ) -> str | None:
+        """Convert the value from the DB."""
+        return self.to_python(value)
+
+    def formfield(
+        self: VerseField,
+        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."""
+        return super().formfield(
+            **{
+                "form_class": forms.CharField,
+                **kwargs,
+            },
+        )
+
+    def get_db_prep_save(
+        self: VerseField,
+        value: int | str | None,
+        **kwargs: Any,
+    ) -> int | None:
+        """Validate and convert the value to a verse id int before saving to the DB."""
+        if not value:
+            return None
+
+        if isinstance(value, str):
+            references = bible.get_references(value)
+
+            if verse_ids := bible.convert_references_to_verse_ids(references):
+                value = verse_ids[0]
+            else:
+                error_message = f"{value} does not contain a valid Scripture reference."
+                raise ValidationError(error_message)
+
+        if not bible.is_valid_verse_id(value):
+            error_message = f"{value} is not a valid verse id."
+            raise ValidationError(error_message)
+
+        return int(value)
+
+    def get_internal_type(self: VerseField) -> str:
+        """Return the internal type (IntegerField) for the VerseField field."""
+        return "IntegerField"