django-alive-checks 0.1__tar.gz

django_alive_checks-0.1/.github/workflows/python-tests.yml

@@ -0,0 +1,56 @@
+name: Django Tests
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        python-version: ['3.9', '3.10', '3.11', '3.12']
+        django-version: ['4.2.*', '5.0.*', '5.1.*']
+
+        exclude:
+          # Django 5.x does not support Python 3.9
+          - python-version: '3.9'
+            django-version: '5.1.*'
+
+          - python-version: '3.9'
+            django-version: '5.0.*'
+
+          # Python 3.12 is not supported with Django 4.2
+          - python-version: '3.12'
+            django-version: '4.2.*'
+      fail-fast: false
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install tox black isort
+
+    - name: Run tests
+      run: |
+        pip install "Django==${{ matrix.django-version }}"
+        pip install -e .[elasticsearch]
+        python -m unittest discover
+
+    - name: Check code style with black
+      run: |
+        black --check .
+
+    - name: Check import order with isort
+      run: |
+        isort --check-only .

django_alive_checks-0.1/.gitignore

@@ -0,0 +1,51 @@
+*.py[cod]
+
+# C extensions
+*.so
+
+# Packages
+*.egg
+*.egg-info
+dist
+build
+eggs
+parts
+bin
+var
+sdist
+develop-eggs
+.installed.cfg
+lib
+lib64
+
+# Installer logs
+pip-log.txt
+
+# Unit test / coverage reports
+.coverage
+.tox
+nosetests.xml
+
+# Translations
+*.mo
+
+# Mr Developer
+.mr.developer.cfg
+.project
+.pydevproject
+demoproject/static
+
+*.db
+*nbproject*
+*devserver*
+*.idea*
+docs/build/*
+build/
+dist/
+*.egg-info/*
+*sublime*
+*~
+*.swp
+*.swo
+*.swn
+*.orig

django_alive_checks-0.1/LICENSE

@@ -0,0 +1,23 @@
+All original code is provided under the MIT License:
+
+The MIT License (MIT)
+
+Copyright (c) 2018 Lincoln Loop, LLC
+
+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.

django_alive_checks-0.1/PKG-INFO

@@ -0,0 +1,89 @@
+Metadata-Version: 2.1
+Name: django-alive-checks
+Version: 0.1
+Summary: Additional health checks for django-alive
+Home-page: https://github.com/PetrDlouhy/django-alive-checks
+Author: Your Name
+Author-email: your.email@example.com
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: Django
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: Django>=3.2
+Requires-Dist: django-alive
+Provides-Extra: elasticsearch
+Requires-Dist: elasticsearch>=7.0.0; extra == "elasticsearch"
+
+django-alive-checks
+===================
+
+`django-alive-checks` is a Django application that provides additional health checks for your Django projects. These checks are designed to work with the `django-alive <https://github.com/pinax/django-alive>`_ package but include dependencies that cannot be part of `django-alive` itself.
+
+Installation
+------------
+
+You can install the base package with:
+
+.. code-block:: bash
+
+    pip install django-alive-checks
+
+If you want to include support for Elasticsearch, install with:
+
+.. code-block:: bash
+
+    pip install django-alive-checks[elasticsearch]
+
+
+Integration with django-alive
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+To integrate the ``check_elasticsearch`` function with your ``django-alive`` checks, you can add it to your health checks configuration:
+
+.. code-block:: python
+
+    # settings.py
+
+    ALIVE_CHECKS = [
+        ...
+        ("alive_checks.checks.check_elasticsearch", {"settings": ES_SETTINGS}),
+    ]
+
+Where the ``ES_SETTINGS`` contains settings that you pass to ``elsaticsearch.Elasticsearch``.
+
+
+Testing
+-------
+
+To run the tests for this project:
+
+.. code-block:: bash
+
+    python -m unittest discover
+
+The tests cover the following scenarios:
+
+- Successful connection to Elasticsearch.
+- Failed connection to Elasticsearch.
+- Exceptions during connection attempts.
+- Handling the absence of the ``elasticsearch`` package.
+
+Contributing
+------------
+
+Contributions are welcome! If you encounter any issues, have ideas for improvements, or want to add more checks, feel free to open an issue or submit a pull request.
+
+License
+-------
+
+This project is licensed under the MIT License. See the `LICENSE` file for more details.
+
+Acknowledgments
+---------------
+
+Thanks to the Django and Elasticsearch communities for their continued support and development of the libraries that make this project possible.
+

django_alive_checks-0.1/README.rst

@@ -0,0 +1,69 @@
+django-alive-checks
+===================
+
+`django-alive-checks` is a Django application that provides additional health checks for your Django projects. These checks are designed to work with the `django-alive <https://github.com/pinax/django-alive>`_ package but include dependencies that cannot be part of `django-alive` itself.
+
+Installation
+------------
+
+You can install the base package with:
+
+.. code-block:: bash
+
+    pip install django-alive-checks
+
+If you want to include support for Elasticsearch, install with:
+
+.. code-block:: bash
+
+    pip install django-alive-checks[elasticsearch]
+
+
+Integration with django-alive
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+To integrate the ``check_elasticsearch`` function with your ``django-alive`` checks, you can add it to your health checks configuration:
+
+.. code-block:: python
+
+    # settings.py
+
+    ALIVE_CHECKS = [
+        ...
+        ("alive_checks.checks.check_elasticsearch", {"settings": ES_SETTINGS}),
+    ]
+
+Where the ``ES_SETTINGS`` contains settings that you pass to ``elsaticsearch.Elasticsearch``.
+
+
+Testing
+-------
+
+To run the tests for this project:
+
+.. code-block:: bash
+
+    python -m unittest discover
+
+The tests cover the following scenarios:
+
+- Successful connection to Elasticsearch.
+- Failed connection to Elasticsearch.
+- Exceptions during connection attempts.
+- Handling the absence of the ``elasticsearch`` package.
+
+Contributing
+------------
+
+Contributions are welcome! If you encounter any issues, have ideas for improvements, or want to add more checks, feel free to open an issue or submit a pull request.
+
+License
+-------
+
+This project is licensed under the MIT License. See the `LICENSE` file for more details.
+
+Acknowledgments
+---------------
+
+Thanks to the Django and Elasticsearch communities for their continued support and development of the libraries that make this project possible.
+

django_alive_checks-0.1/alive_checks/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class AliveChecksConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "alive_checks"

django_alive_checks-0.1/alive_checks/checks/__init__.py

@@ -0,0 +1 @@
+from .elasticsearch import *

django_alive_checks-0.1/alive_checks/checks/elasticsearch.py

@@ -0,0 +1,38 @@
+import logging
+
+from django.core.exceptions import ImproperlyConfigured
+
+try:
+    from elasticsearch import Elasticsearch
+except ImportError:
+    Elasticsearch = None
+
+
+class HealthcheckFailure(Exception):
+    pass
+
+
+log = logging.getLogger(__name__)
+
+
+def check_elasticsearch(settings=None):
+    # type: (dict) -> None
+    """
+    Ping the Elasticsearch server to verify it's reachable
+    :param dict settings: Elasticsearch settings
+    :return None:
+    """
+    if Elasticsearch is None:
+        raise ImproperlyConfigured("elasticsearch package is not installed")
+
+    if settings is None:
+        settings = {}
+
+    try:
+        ping = Elasticsearch(settings).ping()
+    except Exception:
+        log.exception("Elasticsearch connection failed")
+        raise HealthcheckFailure("Elasticsearch exception")
+    if not ping:
+        log.error("Elasticsearch ping failed")
+        raise HealthcheckFailure("Elasticsearch error")

django_alive_checks-0.1/alive_checks/tests/test_elasticsearch_check.py

@@ -0,0 +1,28 @@
+from unittest import TestCase, mock
+
+from django.core.exceptions import ImproperlyConfigured
+
+from alive_checks.checks import HealthcheckFailure, check_elasticsearch
+
+
+class ElasticsearchCheckTests(TestCase):
+
+    @mock.patch("alive_checks.checks.elasticsearch.Elasticsearch")
+    def test_elasticsearch_ping_success(self, mock_elasticsearch):
+        mock_elasticsearch.return_value.ping.return_value = True
+        try:
+            check_elasticsearch()
+        except HealthcheckFailure:
+            self.fail("HealthcheckFailure raised unexpectedly")
+
+    @mock.patch("alive_checks.checks.elasticsearch.Elasticsearch")
+    def test_elasticsearch_ping_failure(self, mock_elasticsearch):
+        mock_elasticsearch.return_value.ping.return_value = False
+        with self.assertRaises(HealthcheckFailure):
+            check_elasticsearch()
+
+    @mock.patch("alive_checks.checks.elasticsearch.Elasticsearch")
+    def test_elasticsearch_exception(self, mock_elasticsearch):
+        mock_elasticsearch.side_effect = Exception("Connection failed")
+        with self.assertRaises(HealthcheckFailure):
+            check_elasticsearch()

django_alive_checks-0.1/django_alive_checks.egg-info/PKG-INFO

@@ -0,0 +1,89 @@
+Metadata-Version: 2.1
+Name: django-alive-checks
+Version: 0.1
+Summary: Additional health checks for django-alive
+Home-page: https://github.com/PetrDlouhy/django-alive-checks
+Author: Your Name
+Author-email: your.email@example.com
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: Django
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: Django>=3.2
+Requires-Dist: django-alive
+Provides-Extra: elasticsearch
+Requires-Dist: elasticsearch>=7.0.0; extra == "elasticsearch"
+
+django-alive-checks
+===================
+
+`django-alive-checks` is a Django application that provides additional health checks for your Django projects. These checks are designed to work with the `django-alive <https://github.com/pinax/django-alive>`_ package but include dependencies that cannot be part of `django-alive` itself.
+
+Installation
+------------
+
+You can install the base package with:
+
+.. code-block:: bash
+
+    pip install django-alive-checks
+
+If you want to include support for Elasticsearch, install with:
+
+.. code-block:: bash
+
+    pip install django-alive-checks[elasticsearch]
+
+
+Integration with django-alive
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+To integrate the ``check_elasticsearch`` function with your ``django-alive`` checks, you can add it to your health checks configuration:
+
+.. code-block:: python
+
+    # settings.py
+
+    ALIVE_CHECKS = [
+        ...
+        ("alive_checks.checks.check_elasticsearch", {"settings": ES_SETTINGS}),
+    ]
+
+Where the ``ES_SETTINGS`` contains settings that you pass to ``elsaticsearch.Elasticsearch``.
+
+
+Testing
+-------
+
+To run the tests for this project:
+
+.. code-block:: bash
+
+    python -m unittest discover
+
+The tests cover the following scenarios:
+
+- Successful connection to Elasticsearch.
+- Failed connection to Elasticsearch.
+- Exceptions during connection attempts.
+- Handling the absence of the ``elasticsearch`` package.
+
+Contributing
+------------
+
+Contributions are welcome! If you encounter any issues, have ideas for improvements, or want to add more checks, feel free to open an issue or submit a pull request.
+
+License
+-------
+
+This project is licensed under the MIT License. See the `LICENSE` file for more details.
+
+Acknowledgments
+---------------
+
+Thanks to the Django and Elasticsearch communities for their continued support and development of the libraries that make this project possible.
+

django_alive_checks-0.1/django_alive_checks.egg-info/SOURCES.txt

@@ -0,0 +1,16 @@
+.gitignore
+LICENSE
+README.rst
+setup.py
+.github/workflows/python-tests.yml
+alive_checks/__init__.py
+alive_checks/apps.py
+alive_checks/checks/__init__.py
+alive_checks/checks/elasticsearch.py
+alive_checks/tests/__init__.py
+alive_checks/tests/test_elasticsearch_check.py
+django_alive_checks.egg-info/PKG-INFO
+django_alive_checks.egg-info/SOURCES.txt
+django_alive_checks.egg-info/dependency_links.txt
+django_alive_checks.egg-info/requires.txt
+django_alive_checks.egg-info/top_level.txt

django_alive_checks-0.1/django_alive_checks.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

django_alive_checks-0.1/django_alive_checks.egg-info/requires.txt

@@ -0,0 +1,5 @@
+Django>=3.2
+django-alive
+
+[elasticsearch]
+elasticsearch>=7.0.0

django_alive_checks-0.1/django_alive_checks.egg-info/top_level.txt

@@ -0,0 +1 @@
+alive_checks

django_alive_checks-0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

django_alive_checks-0.1/setup.py

@@ -0,0 +1,29 @@
+from setuptools import find_packages, setup
+
+setup(
+    name="django-alive-checks",
+    version="0.1",
+    packages=find_packages(),
+    include_package_data=True,
+    install_requires=[
+        "Django>=3.2",
+        "django-alive",
+    ],
+    extras_require={
+        "elasticsearch": ["elasticsearch>=7.0.0"],
+    },
+    description="Additional health checks for django-alive",
+    long_description=open("README.rst").read(),
+    long_description_content_type="text/x-rst",
+    url="https://github.com/PetrDlouhy/django-alive-checks",
+    author="Your Name",
+    author_email="your.email@example.com",
+    classifiers=[
+        "Development Status :: 3 - Alpha",
+        "Framework :: Django",
+        "Intended Audience :: Developers",
+        "License :: OSI Approved :: MIT License",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.8",
+    ],
+)