Skip to content
This repository was archived by the owner on Jun 22, 2025. It is now read-only.

Commit 04f024f

Browse files
Add extras for templating
One of our examples shows off the use of Jinja2 for templating HTML files, but we don't make it easy or clear for users to know how to enable support. This adds an entry to the readme and indicates supported versions of Jinja2 via `extras_require` in `setup.py`
1 parent 1382d8c commit 04f024f

File tree

2 files changed

+9
-0
lines changed

2 files changed

+9
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,12 @@ Install from pypi with `pip`:
5858
pip install eel
5959
```
6060

61+
To include support for HTML templating, currently using [Jinja2](https://pypi.org/project/Jinja2/#description):
62+
63+
```shell
64+
pip install eel[jinja2]
65+
```
66+
6167
## Usage
6268

6369
### Directory Structure

setup.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@
1515
'eel': ['eel.js'],
1616
},
1717
install_requires=['bottle', 'bottle-websocket', 'future', 'whichcraft'],
18+
extras_require={
19+
"jinja2": ['jinja2>=2.10']
20+
},
1821
python_requires='>=3.6',
1922
description='For little HTML GUI applications, with easy Python/JS interop',
2023
long_description=long_description,

0 commit comments

Comments
 (0)