webview-python 1.1.3__cp314-cp314-win_amd64.whl

webview_python-1.1.3.dist-info/METADATA

@@ -0,0 +1,421 @@
+Metadata-Version: 2.4
+Name: webview_python
+Version: 1.1.3
+Summary: Python bindings for the webview library, which completely follow deno_webview design and principles
+License: MIT License
+        
+        Copyright (c) 2024 Python Webview Contributors
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/congzhangzh/webview_python
+Project-URL: Repository, https://github.com/congzhangzh/webview_python.git
+Project-URL: Bug Tracker, https://github.com/congzhangzh/webview_python/issues
+Keywords: webview,gui,desktop,application,html,web
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: User Interfaces
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# Webview Python
+
+[![Test - Windows](https://github.com/congzhangzh/webview_python/actions/workflows/test.yml/badge.svg?branch=main&event=push&label=Windows)](https://github.com/congzhangzh/webview_python/actions/workflows/test.yml)
+[![Test - Linux](https://github.com/congzhangzh/webview_python/actions/workflows/test.yml/badge.svg?branch=main&event=push&label=Linux)](https://github.com/congzhangzh/webview_python/actions/workflows/test.yml)
+[![Test - macOS](https://github.com/congzhangzh/webview_python/actions/workflows/test.yml/badge.svg?branch=main&event=push&label=macOS)](https://github.com/congzhangzh/webview_python/actions/workflows/test.yml)
+[![PyPI version](https://badge.fury.io/py/webview_python.svg)](https://badge.fury.io/py/webview_python)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Python Version](https://img.shields.io/pypi/pyversions/webview_python.svg)](https://pypi.org/project/webview_python/)
+
+Python bindings for the webview library, allowing you to create desktop applications with web technologies.
+
+## Production-Ready Applications
+
+For enterprise-grade desktop applications, see the complete template: [python_desktop_app_with_vue_template](https://github.com/congzhangzh/python_desktop_app_with_vue_template). This project provides a full solution for frontend-backend integration, development workflow, debugging, and deployment.
+
+## Alternative: WebUI
+
+While developing the production template, I discovered [WebUI](https://webui.me/), which appears to be an earlier project than webview/webview (though I haven't verified this claim). WebUI might be worth investigating as an alternative, but I haven't had time to do a thorough comparison. If anyone has insights or experience with WebUI vs webview, I'd appreciate hearing from you.
+
+## Installation
+
+```bash
+pip install webview_python
+```
+
+## Environment Variables
+
+Webview Python supports the following environment variables:
+
+- `WEBVIEW_VERSION`: Specify the version of the webview library to use (default: "0.9.0")
+- `WEBVIEW_DOWNLOAD_BASE`: Specify the base URL or file path for downloading webview libraries (default: GitHub releases)
+  - Can be a web URL: `https://internal-server.com/webview-libs`
+  - Network share: `\\server\share\webview-libs` or `/mnt/server/webview-libs`
+  - Local path: `/path/to/libs` or `C:\path\to\libs`
+
+Example usage:
+```bash
+# Using an internal HTTP server
+export WEBVIEW_DOWNLOAD_BASE="http://internal-server.com/webview-libs"
+
+# Using a network share on Windows
+set WEBVIEW_DOWNLOAD_BASE=\\\\server\\share\\webview-libs
+
+# Using a mounted path on Linux
+export WEBVIEW_DOWNLOAD_BASE="/mnt/server/webview-libs"
+```
+
+Note: When using a custom download location, you must organize the libraries in the same structure as the GitHub releases:
+```
+WEBVIEW_DOWNLOAD_BASE/
+├── 0.9.0/
+│   ├── webview.dll               # Windows x64
+│   ├── WebView2Loader.dll        # Windows x64
+│   ├── libwebview.x86_64.so      # Linux x64
+│   ├── libwebview.aarch64.so     # Linux ARM64
+│   ├── libwebview.x86_64.dylib   # macOS x64
+│   └── libwebview.aarch64.dylib  # macOS ARM64
+└── other-versions/...
+```
+
+## Usage
+
+### Display Inline HTML:
+
+```python
+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:
+
+```python
+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:
+
+```python
+from webview.webview import Webview
+webview = Webview()
+webview.navigate("https://www.python.org")
+webview.run()
+```
+
+### Python-JavaScript Bindings:
+
+```python
+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()
+```
+
+### Async Python Functions with JavaScript:
+
+Webview Python supports binding asynchronous Python functions that can be called from JavaScript. This is useful for time-consuming operations that should not block the main thread.
+
+Demo: [bind_in_local_async_by_asyncio_guest_win32_wip.py](examples/async_with_asyncio_guest_run/bind_in_local_async_by_asyncio_guest_win32_wip.py), [bind_in_local_async.html](examples/async_with_asyncio_guest_run/bind_in_local_async.html)
+
+```python
+import asyncio
+from webview.webview import Webview, Size, SizeHint
+
+webview = Webview(debug=True)
+
+# Async Python function that can be called from JavaScript
+async def delayed_message(message, delay=1):
+    # Simulating a time-consuming operation
+    await asyncio.sleep(delay)
+    return f"Async response after {delay}s: {message}"
+
+# Async function with progress reporting
+async def process_with_progress(steps=5, step_time=1):
+    results = []
+    for i in range(1, steps + 1):
+        await asyncio.sleep(step_time)
+        # Report progress to JavaScript
+        progress = (i / steps) * 100
+        webview.eval(f"updateProgress({progress}, 'Processing: Step {i}/{steps}')")
+        results.append(f"Step {i} completed")
+    
+    return {
+        "status": "complete",
+        "steps": steps,
+        "results": results
+    }
+
+# Bind async Python functions
+webview.bind("delayedMessage", delayed_message)
+webview.bind("processWithProgress", process_with_progress)
+
+# HTML/JavaScript
+html = """
+<html>
+<head>
+    <script>
+        async function callAsyncPython() {
+            try {
+                document.getElementById('result').innerHTML = "Waiting for async response...";
+                const result = await delayedMessage("Hello from async world!", 2);
+                document.getElementById('result').innerHTML = result;
+            } catch (err) {
+                document.getElementById('result').innerHTML = `Error: ${err}`;
+            }
+        }
+        
+        function updateProgress(percent, message) {
+            document.getElementById('progress').style.width = percent + '%';
+            document.getElementById('progress-text').textContent = message;
+        }
+    </script>
+</head>
+<body>
+    <button onclick="callAsyncPython()">Call Async Python</button>
+    <div id="result"></div>
+    <div id="progress" style="background-color: #ddd; width: 100%">
+        <div id="progress-bar" style="height: 20px; background-color: #4CAF50; width: 0%"></div>
+    </div>
+    <div id="progress-text"></div>
+</body>
+</html>
+"""
+
+webview.navigate(f"data:text/html,{quote(html)}")
+webview.run()
+```
+
+For a more complete example, see [bind_in_local_async.py](examples/bind_in_local_async.py) and [bind_in_local_async.html](examples/bind_in_local_async.html) in the examples directory.
+
+## Features
+
+- Create desktop applications using HTML, CSS, and JavaScript
+- Load local HTML files or remote URLs
+- Bidirectional Python-JavaScript communication
+- Support for async Python functions with JavaScript promises
+- Progress reporting for long-running tasks
+- Window size and title customization
+- Debug mode for development
+- Cross-platform support (Windows, macOS, Linux)
+
+## Development
+
+### Setup Development Environment
+
+```bash
+# 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
+
+```bash
+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:
+1. **Test**
+```bash
+# Install dependencies if not installed 
+pip install -r requirements.txt
+
+# Run tests
+pytest
+
+# Build wheels
+python -m build -n -w
+```
+
+2. **Update Version**
+   ```bash
+   # Ensure you have the latest code
+   git pull origin main
+   
+   # Update version in pyproject.toml
+   # Edit version = "x.y.z" to new version number
+   ```
+
+3. **Create Release**
+   ```bash
+   # Commit changes
+   old_version=1.1.1
+   new_version=1.1.2
+   git add pyproject.toml README.md
+   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}"
+   ```
+
+4. **Monitor Release**
+   - Check GitHub Actions progress in the Actions tab
+   - Verify package on PyPI after workflow completion
+
+### First-time Release Setup
+
+1. **PyPI Setup**
+   - Create account: https://pypi.org/account/register/
+   - Generate API token: https://pypi.org/manage/account/token/
+
+2. **GitHub Setup**
+   - Repository Settings → Secrets and variables → Actions
+   - Add new secret: `PYPI_API_TOKEN` with PyPI token value
+
+## Roadmap
+
+- [x] Publish to PyPI
+- [x] Setup GitHub Actions for CI/CD
+- [x] Add async function support 
+- [x] 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
+
+## TBD
+- [x] CTRL-C support
+
+## References
+
+- [Webview](https://github.com/webview/webview)
+- [webview C API IMPL](https://github.com/webview/webview/blob/master/core/include/webview/c_api_impl.hh)
+- [Webview C API](https://github.com/webview/webview/blob/master/src/webview.h)
+- [webview_deno](https://github.com/eliassjogreen/webview_deno)
+- [asyncio-guest](https://github.com/congzhangzh/asyncio-guest)
+- [asyncio-guest win32](https://github.com/congzhangzh/asyncio-guest/blob/master/asyncio_guest/asyncio_guest_win32.py)
+
+# License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

webview_python-1.1.3.dist-info/RECORD

@@ -0,0 +1,10 @@
+webview/__init__.py,sha256=JuNAt_hPXKYzZnm2GNxwcjuJnHOENC3_iuqI74iDVqY,46
+webview/_dummy_holder.c,sha256=tNfuKbqPQTnCB0e2dpRlc7-FATDmyYks8s2skwXSH4c,188177
+webview/_dummy_holder.cp314-win_amd64.pyd,sha256=qb7uAZMZvw26EtauAUDzRchTWnI2sLmoKLZC14NwhNM,16384
+webview/_webview_ffi.py,sha256=R5WvyBGQ0672WppsHe_3ZVL_z2AIVUIqORIz7aIErm0,6963
+webview/webview.py,sha256=UzNHRXuDkpNaOVb7A4br3jRofuPYX6fNvAD-OONKsNc,3746
+webview_python-1.1.3.dist-info/licenses/LICENSE,sha256=4za-tnz_zaV1oY5vxbtLpVy2TvyOcRkT0nsku5qobSg,1105
+webview_python-1.1.3.dist-info/METADATA,sha256=SYtyz_H11lcONeBt2onQF4qei5NKBr2tf0M_fL2BYX8,15030
+webview_python-1.1.3.dist-info/WHEEL,sha256=MRIqJmWGXGbCDxvKAKUMbTPbbQhv9CNuiiNgFEELfOM,101
+webview_python-1.1.3.dist-info/top_level.txt,sha256=d5SpaV1yBkWk3tar-VrEOX-bBM9jXPlVdVNpN5FQrxA,8
+webview_python-1.1.3.dist-info/RECORD,,

webview_python-1.1.3.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.0)
+Root-Is-Purelib: false
+Tag: cp314-cp314-win_amd64
+

webview_python-1.1.3.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Python Webview Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

webview_python-1.1.3.dist-info/top_level.txt

@@ -0,0 +1 @@
+webview