Python bindings for the webview library, which completely follow deno_webview design and principles
Project description
Webview Python
Python bindings for the webview library, allowing you to create desktop applications with web technologies.
Installation
pip install webview_python
Usage
Display Inline HTML:
from webview.webview import Webview
from urllib.parse import quote
html = """
<html>
<body>
<h1>Hello from Python Webview!</h1>
</body>
</html>
"""
webview = Webview()
webview.navigate(f"data:text/html,{quote(html)}")
webview.run()
Load Local HTML File:
from webview.webview import Webview
import os
webview = Webview()
current_dir = os.path.dirname(os.path.abspath(__file__))
html_path = os.path.join(current_dir, 'local.html')
webview.navigate(f"file://{html_path}")
webview.run()
Load Remote URL:
from webview.webview import Webview
webview = Webview()
webview.navigate("https://www.python.org")
webview.run()
Python-JavaScript Bindings:
from webview.webview import Webview, Size, SizeHint
from urllib.parse import quote
webview = Webview(debug=True)
# Python functions that can be called from JavaScript
def hello():
webview.eval("updateFromPython('Hello from Python!')")
return "Hello from Python!"
def add(a, b):
return a + b
# Bind Python functions
webview.bind("hello", hello)
webview.bind("add", add)
# Configure window
webview.title = "Python-JavaScript Binding Demo"
webview.size = Size(640, 480, SizeHint.FIXED)
# Load HTML with JavaScript
html = """
<html>
<head>
<title>Python-JavaScript Binding Demo</title>
<script>
async function callPython() {
const result = await hello();
document.getElementById('result').innerHTML = result;
}
async function callPythonWithArgs() {
const result = await add(40, 2);
document.getElementById('result').innerHTML = `Result: ${result}`;
}
function updateFromPython(message) {
document.getElementById('result').innerHTML = `Python says: ${message}`;
}
</script>
</head>
<body>
<h1>Python-JavaScript Binding Demo</h1>
<button onclick="callPython()">Call Python</button>
<button onclick="callPythonWithArgs()">Call Python with Args</button>
<div id="result"></div>
</body>
</html>
"""
webview.navigate(f"data:text/html,{quote(html)}")
webview.run()
Features
- Create desktop applications using HTML, CSS, and JavaScript
- Load local HTML files or remote URLs
- Bidirectional Python-JavaScript communication
- Window size and title customization
- Debug mode for development
- Cross-platform support (Windows, macOS, Linux)
Development
Setup Development Environment
# Install Python build tools
pip install --upgrade pip build twine
# Install GitHub CLI (choose one based on your OS):
# macOS
brew install gh
# Windows
winget install GitHub.cli
# or
choco install gh
# Linux (Debian/Ubuntu)
curl -fsSL https://cli.github.com/packages/githubcli-archive-keyring.gpg | sudo dd of=/usr/share/keyrings/githubcli-archive-keyring.gpg \
&& echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/githubcli-archive-keyring.gpg] https://cli.github.com/packages stable main" | sudo tee /etc/apt/sources.list.d/github-cli.list > /dev/null \
&& sudo apt update \
&& sudo apt install gh
Running Tests
python -m unittest discover tests
Project Structure
webview_python/
├── src/
│ ├── webview.py # Main webview implementation
│ └── ffi.py # Foreign Function Interface
├── examples/ # Example applications
├── tests/ # Unit tests
└── README.md # Documentation
Release Process
For maintainers who want to release a new version:
- Test
# Install dependencies if not installed
pip install -r requirements.txt
# Run tests
pytest
# Build wheels
python -m build -n -w
-
Update Version
# Ensure you have the latest code git pull origin main # Update version in pyproject.toml # Edit version = "x.y.z" to new version number
-
Create Release
# Commit changes old_version=0.99.0 new_version=0.99.1 git add pyproject.toml git commit -m "Bump version to ${new_version}" git push origin main # Create and push tag git tag v${new_version} git push origin v${new_version} # Create GitHub release gh release create v${new_version} --title "${new_version}" \ --notes "Full Changelog: https://github.com/congzhangzh/webview_python/compare/v${old_version}...v${new_version}"
-
Monitor Release
- Check GitHub Actions progress in the Actions tab
- Verify package on PyPI after workflow completion
First-time Release Setup
-
PyPI Setup
- Create account: https://pypi.org/account/register/
- Generate API token: https://pypi.org/manage/account/token/
-
GitHub Setup
- Repository Settings → Secrets and variables → Actions
- Add new secret:
PYPI_API_TOKENwith PyPI token value
Roadmap
- Publish to PyPI
- Setup GitHub Actions for CI/CD
- Add preact example
- Add three.js example
- Add three.js fiber example
- Add screen saver 4 window example
- Add MRI principle demo example by three.js fiber
- Add screen saver 4 windows with MRI principle demo example by three.js fiber
References
License
This project is licensed under the MIT License - see the LICENSE file for details.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distributions
File details
Details for the file webview_python-0.99.16-cp312-cp312-win_amd64.whl.
File metadata
- Download URL: webview_python-0.99.16-cp312-cp312-win_amd64.whl
- Upload date:
- Size: 44.7 kB
- Tags: CPython 3.12, Windows x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 44f225d4465eaf35a213f66caab94a892f6d83e186d265389fb2009d5eef64af |
|
| MD5 | 9c625ac2022ae167f576a041efc026ca |
|
| BLAKE2b-256 | 107ee862d1657f9a77e1b718aabc715ff84a67a259421a19996327017cdbab8c |
File details
Details for the file webview_python-0.99.16-cp312-cp312-musllinux_1_1_x86_64.whl.
File metadata
- Download URL: webview_python-0.99.16-cp312-cp312-musllinux_1_1_x86_64.whl
- Upload date:
- Size: 66.4 kB
- Tags: CPython 3.12, musllinux: musl 1.1+ x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f947f2dafd6bb77fa268329af04c4f4f35b3760c35666170f9c848fe4eb24c6b |
|
| MD5 | 7bea0e1af64ca2b6fea952a4686b0b37 |
|
| BLAKE2b-256 | 39e37d20dafce475032c1b89ecc77235924966cbfd844d6096efccd85b07fb7f |
File details
Details for the file webview_python-0.99.16-cp312-cp312-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl.
File metadata
- Download URL: webview_python-0.99.16-cp312-cp312-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl
- Upload date:
- Size: 63.1 kB
- Tags: CPython 3.12, manylinux: glibc 2.17+ x86-64, manylinux: glibc 2.5+ x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 00b79b7f1cbee8828b4fb64242969a728029c789c3389ae7188a174457250b35 |
|
| MD5 | e7c59f4d6fe000e754c230a8b1d2f8e3 |
|
| BLAKE2b-256 | 76ce90d9d179e8a620c0f6789239dacb654f32a6160a7cabc4ab70a8ca015287 |
File details
Details for the file webview_python-0.99.16-cp312-cp312-macosx_11_0_arm64.whl.
File metadata
- Download URL: webview_python-0.99.16-cp312-cp312-macosx_11_0_arm64.whl
- Upload date:
- Size: 42.0 kB
- Tags: CPython 3.12, macOS 11.0+ ARM64
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c8b573d072316f37e70ca8fec0cdd3e042bbb8b6ebb1a4968704ca197bcdfed1 |
|
| MD5 | b5f5f346f73027aa91c61e7069cd81b1 |
|
| BLAKE2b-256 | 5858ab87f1489c7f323de55356c0c9f788a03472c1249a5f12e114e0e7755d29 |
File details
Details for the file webview_python-0.99.16-cp312-cp312-macosx_10_9_x86_64.whl.
File metadata
- Download URL: webview_python-0.99.16-cp312-cp312-macosx_10_9_x86_64.whl
- Upload date:
- Size: 41.5 kB
- Tags: CPython 3.12, macOS 10.9+ x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2e5e4506ac0bc13432859e24cf63a22c5342825426998eb0b0b9403c09296016 |
|
| MD5 | d1050a4030e1fd9ae90d2985e258b82f |
|
| BLAKE2b-256 | 3fa602b62634ad2c1c1186f0a4a24598f058506b7b88402fb6843e5c67318e5d |
