Merge branch 'master' into master

Author: krpatter-intc

.github/FUNDING.yml

@@ -0,0 +1,10 @@
+github: samuelhwilliams
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.github/ISSUE_TEMPLATE/help-me.md

@@ -11,6 +11,9 @@ assignees: ''
 A clear and concise description of what you're trying to accomplish, and where you're having difficulty.
 
 **Code snippet(s)**
+Here is some code that can be easily used to reproduce the problem or understand what I need help with.
+
+- [ ] I know that if I don't provide sample code that allows someone to quickly step into my shoes, I may not get the help I want or my issue may be closed.
 
 ```python
 import eel

CHANGELOG.md

@@ -1,5 +1,15 @@
 # Change log
 
+### v0.13.0
+* Drop support for Python versions below 3.6
+* Add `jinja2` as an extra for pip installation, e.g. `pip install eel[jinja2]`.
+* Bump dependencies in examples to dismiss github security notices. We probably want to set up a policy to ignore example dependencies as they shouldn't be considered a source of vulnerabilities.
+* Disable edge on non-Windows platforms until we implement proper support.
+
+### v0.12.4
+* Return greenlet task from `spawn()` ([#300](https://github.com/samuelhwilliams/Eel/pull/300))
+* Set JS mimetype to reduce errors on Windows platform ([#289](https://github.com/samuelhwilliams/Eel/pull/289))
+
 ### v0.12.3
 * Search for Chromium on macOS.
 

README.md

@@ -1,5 +1,16 @@
 # Eel
 
+[![PyPI version](https://img.shields.io/pypi/v/Eel?style=for-the-badge)](https://pypi.org/project/Eel/)
+![PyPi Downloads](https://img.shields.io/pypi/dm/Eel?style=for-the-badge)
+![Python](https://img.shields.io/pypi/pyversions/Eel?style=for-the-badge)
+[![License](https://img.shields.io/pypi/l/Eel.svg?style=for-the-badge)](https://pypi.org/project/Eel/)
+
+
+[![Total alerts](https://img.shields.io/lgtm/alerts/g/samuelhwilliams/Eel.svg?logo=lgtm&style=for-the-badge)](https://lgtm.com/projects/g/samuelhwilliams/Eel/alerts/)
+[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/samuelhwilliams/Eel.svg?logo=lgtm&style=for-the-badge)](https://lgtm.com/projects/g/samuelhwilliams/Eel/context:javascript)
+[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/samuelhwilliams/Eel.svg?logo=lgtm&style=for-the-badge)](https://lgtm.com/projects/g/samuelhwilliams/Eel/context:python)
+
+
 Eel is a little Python library for making simple Electron-like offline HTML/JS GUI apps, with full access to Python capabilities and libraries.
 
 > **Eel hosts a local webserver, then lets you annotate functions in Python so that they can be called from Javascript, and vice versa.**
@@ -47,6 +58,12 @@ Install from pypi with `pip`:
 pip install eel
 ```
 
+To include support for HTML templating, currently using [Jinja2](https://pypi.org/project/Jinja2/#description):
+
+```shell
+pip install eel[jinja2]
+```
+
 ## Usage
 
 ### Directory Structure

eel/__init__.py

@@ -1,4 +1,3 @@
-from __future__ import print_function   # Python 2 compatibility stuff
 from builtins import range
 import traceback
 from io import open
@@ -14,7 +13,9 @@
 import sys
 import pkg_resources as pkg
 import socket
+import mimetypes
 
+mimetypes.add_type('application/javascript', '.js')
 _eel_js_file = pkg.resource_filename('eel', 'eel.js')
 _eel_js = open(_eel_js_file, encoding='utf-8').read()
 _websockets = []
@@ -174,7 +175,7 @@ def sleep(seconds):
 
 
 def spawn(function, *args, **kwargs):
-    gvt.spawn(function, *args, **kwargs)
+    return gvt.spawn(function, *args, **kwargs)
 
 # Bottle Routes
 

eel/__main__.py

@@ -1,12 +1,25 @@
-from __future__ import print_function
-import sys
 import pkg_resources as pkg
 import PyInstaller.__main__ as pyi
 import os
+from argparse import ArgumentParser
 
-args = sys.argv[1:]
-main_script = args.pop(0)
-web_folder = args.pop(0)
+parser = ArgumentParser(description="""
+Eel is a little Python library for making simple Electron-like offline HTML/JS GUI apps,
+ with full access to Python capabilities and libraries.
+""")
+parser.add_argument(
+    "main_script",
+    type=str,
+    help="Main python file to run app from"
+)
+parser.add_argument(
+    "web_folder",
+    type=str,
+    help="Folder including all web files including file as html, css, ico, etc."
+)
+args, unknown_args = parser.parse_known_args()
+main_script = args.main_script
+web_folder = args.web_folder
 
 print("Building executable with main script '%s' and web folder '%s'...\n" %
       (main_script, web_folder))
@@ -17,8 +30,7 @@
 
 needed_args = ['--hidden-import', 'bottle_websocket',
                '--add-data', js_file_arg, '--add-data', web_folder_arg]
-full_args = [main_script] + needed_args + args
-
+full_args = [main_script] + needed_args + unknown_args
 print('Running:\npyinstaller', ' '.join(full_args), '\n')
 
 pyi.run(full_args)

eel/edge.py

@@ -1,3 +1,4 @@
+import platform
 import subprocess as sps
 import sys
 
@@ -10,5 +11,7 @@ def run(_path, options, start_urls):
 
 
 def find_path():
-    # Path isn't necessary. Edge is launched with a CLI argument
-    return True
+    if platform.system() == 'Windows':
+        return True
+
+    return False

examples/01 - hello_world/hello.py

@@ -1,4 +1,3 @@
-from __future__ import print_function	# For Py2/3 compatibility
 import eel
 
 # Set web files folder

examples/02 - callbacks/callbacks.py

@@ -1,4 +1,3 @@
-from __future__ import print_function	# For Py2/3 compatibility
 import eel
 import random
 

examples/03 - sync_callbacks/sync_callbacks.py

@@ -1,4 +1,3 @@
-from __future__ import print_function	# For Py2/3 compatibility
 import eel, random
 
 eel.init('web')
@@ -18,4 +17,4 @@ def py_random():
 print('Got this from Javascript:', n)
 
 while True:
-    eel.sleep(1.0)
+    eel.sleep(1.0)