Metadata-Version: 2.4
Name: django_gargoyle_sentinel
Version: 0.1.0
Summary: Django alert about relevant messages via Telegram.
Author-email: Omlad Alan <omladalan@gmail.com>
License-Expression: BSD-3-Clause
Project-URL: Homepage, https://github.com/omladalan/django-gargoyle-sentinel
Classifier: Environment :: Web Environment
Classifier: Framework :: Django :: 6.0
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: django>=6.0.3
Dynamic: license-file

## django_gargoyle_sentinel [CHANGELOG](CHANGELOG.md)

django_gargoyle_sentinel It's a module for alerting relevant security and administration messages via Telegram.


### Quick start

#### 1. Add `django_gargoyle_sentinel` to your `INSTALLED_APPS` setting like this:

```python
    INSTALLED_APPS = [
        ...,
        "django_gargoyle_sentinel",
    ]
```

#### 2. Add this configs in `settings.py`:

```python
    TELEGRAM_ALERT_TOKEN="TELEGRAM_CHATBOT_TOKEN"
    TELEGRAM_ALERT_DESTINY="GROUP ID DESTINY"


    OVERRIDE_SYSTEM_ALERT = True ## IF USED WITH django_subdomain_tenancy
```
### Standalone usage

#### 1. Import

```python
   from django_gargoyle_sentinel.utils.system_alert import system_alert.py
```

#### 2. Using (I recommend placing it in important spots, such as error handlers (try/except) and other relevant locations)

```python
    system_alert(request, message)
```

#### `request` It's being used to reveal the author's IP.
