django-alive-checks
===================
.. image:: https://img.shields.io/pypi/v/django-alive-checks.svg
:target: https://pypi.org/project/django-alive-checks/
:alt: PyPI version
.. image:: https://github.com/PetrDlouhy/django-alive-checks/workflows/Django%20Tests/badge.svg
:target: https://github.com/PetrDlouhy/django-alive-checks/actions
:alt: Build status
`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.
Raw data
{
"_id": null,
"home_page": "https://github.com/PetrDlouhy/django-alive-checks",
"name": "django-alive-checks",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Your Name",
"author_email": "your.email@example.com",
"download_url": "https://files.pythonhosted.org/packages/1d/56/fdb82664b2284a8d326635f07d7b280a734230483ce36a3fa597410cc88c/django_alive_checks-0.2.tar.gz",
"platform": null,
"description": "\n\ndjango-alive-checks\n===================\n\n.. image:: https://img.shields.io/pypi/v/django-alive-checks.svg\n :target: https://pypi.org/project/django-alive-checks/\n :alt: PyPI version\n\n.. image:: https://github.com/PetrDlouhy/django-alive-checks/workflows/Django%20Tests/badge.svg\n :target: https://github.com/PetrDlouhy/django-alive-checks/actions\n :alt: Build status\n\n`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.\n\nInstallation\n------------\n\nYou can install the base package with:\n\n.. code-block:: bash\n\n pip install django-alive-checks\n\nIf you want to include support for Elasticsearch, install with:\n\n.. code-block:: bash\n\n pip install django-alive-checks[elasticsearch]\n\n\nIntegration with django-alive\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nTo integrate the ``check_elasticsearch`` function with your ``django-alive`` checks, you can add it to your health checks configuration:\n\n.. code-block:: python\n\n # settings.py\n\n ALIVE_CHECKS = [\n ...\n (\"alive_checks.checks.check_elasticsearch\", {\"settings\": ES_SETTINGS}),\n ]\n\nWhere the ``ES_SETTINGS`` contains settings that you pass to ``elsaticsearch.Elasticsearch``.\n\n\nTesting\n-------\n\nTo run the tests for this project:\n\n.. code-block:: bash\n\n python -m unittest discover\n\nThe tests cover the following scenarios:\n\n- Successful connection to Elasticsearch.\n- Failed connection to Elasticsearch.\n- Exceptions during connection attempts.\n- Handling the absence of the ``elasticsearch`` package.\n\nContributing\n------------\n\nContributions 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.\n\nLicense\n-------\n\nThis project is licensed under the MIT License. See the `LICENSE` file for more details.\n\nAcknowledgments\n---------------\n\nThanks to the Django and Elasticsearch communities for their continued support and development of the libraries that make this project possible.\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Additional health checks for django-alive",
"version": "0.2",
"project_urls": {
"Homepage": "https://github.com/PetrDlouhy/django-alive-checks"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "38b694874699aae217dbac85c8ee133eaae031343131d7cb74cfdcfd83d6e1a6",
"md5": "368f00ee14e740fc57da35ea585b74e8",
"sha256": "aa7787011e8aa0576319a41ce7dcb9e5ae8b4c81db507183f76126ea9b7c1a1d"
},
"downloads": -1,
"filename": "django_alive_checks-0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "368f00ee14e740fc57da35ea585b74e8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5039,
"upload_time": "2024-08-29T13:48:04",
"upload_time_iso_8601": "2024-08-29T13:48:04.965615Z",
"url": "https://files.pythonhosted.org/packages/38/b6/94874699aae217dbac85c8ee133eaae031343131d7cb74cfdcfd83d6e1a6/django_alive_checks-0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1d56fdb82664b2284a8d326635f07d7b280a734230483ce36a3fa597410cc88c",
"md5": "6225d53185d87e45230662b9f7c284ab",
"sha256": "d887429312f4c68f34435bd67cfa6daf3fa259f41acc149dbd21c7f4594ef50d"
},
"downloads": -1,
"filename": "django_alive_checks-0.2.tar.gz",
"has_sig": false,
"md5_digest": "6225d53185d87e45230662b9f7c284ab",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4758,
"upload_time": "2024-08-29T13:48:05",
"upload_time_iso_8601": "2024-08-29T13:48:05.884437Z",
"url": "https://files.pythonhosted.org/packages/1d/56/fdb82664b2284a8d326635f07d7b280a734230483ce36a3fa597410cc88c/django_alive_checks-0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-29 13:48:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "PetrDlouhy",
"github_project": "django-alive-checks",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "django-alive-checks"
}
JSON
