A simple Django app to integrates with https://www.tawk.to/ chat.
Project description
django-tawkto
django-tawkto is a simple Django app to it integrates with https://www.tawk.to/ chat.
Requirements
Python 3.7 to 3.10 supported.
Django 2.2 to 4.0 supported.
Quick start
Install the stable release from pypi (using pip):
pip install django-tawkto
Add tawkto to your INSTALLED_APPS setting like this:
INSTALLED_APPS = [
...
'tawkto',
]
Add TAWKTO_ID_SITE in settings.py:
TAWKTO_ID_SITE='<tawkto id site>'
(Optional) Add TAWKTO_API_KEY:
TAWKTO_API_KEY='<tawkto api key>'
(Optional) For secure site (requires TAWKTO_API_KEY):
TAWKTO_IS_SECURE=True
In HTML:
{% load tawkto_tags %}
<!DOCTYPE html>
<html lang="en">
<head>
...
</head>
<body>
...
{% tawkto_script %}
</body>
</html>
(Optional) Add visitor name and email:
{% tawkto_script user_name=request.user.get_full_name user_email=request.user.email %}
(Optional) Use a different widget for a given property (default is the default value):
TAWKTO_WIDGET_ID = "default"
or
{% tawkto_script widget_id='somewidgetid' %}
(Optional) Use a different tawkto property:
{% tawkto_script id_site='tawktosideit' api_key='tawktoapikey'%}
(Optional) If you want to hide the chat for superuser (default is True):
TAWKTO_EXCLUDE_SUPERUSERS = True
(Optional) Set custom metadata regarding this chat/visitor:
is_securemust beTrue.- You must provide a valid email.
- Metadata is represented by key and value.
- The key is of the string data type and can contain only alphanumeric characters and ‘-‘ (dash).
- More in https://developer.tawk.to/jsapi/
setAttributessection.
# view.py
def view(request):
context = {'metadata': {'attr-1': 'value1', 'attr-2': 'value2'}}
return render(request, 'template.html', context)
In template:
{% tawkto_script is_secure=True user_email=example@example.com extra_attributes=metadata %}
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file django-tawkto-0.5.0.tar.gz.
File metadata
- Download URL: django-tawkto-0.5.0.tar.gz
- Upload date:
- Size: 4.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 0908c9949b4d719def33b13a0a00a8790121bb476ca9ba4587cc651ff781a937 |
|
| MD5 | 5bcc54b69de462b99a2af67eb580471c |
|
| BLAKE2b-256 | 83a00ec5bf1adb0039d0d85ad3d0d77febad328c38f4063c1330402c7cac8045 |
