Merge pull request #179 from vgalin/develop

html2image v2.0.6

Author: vgalin

.github/workflows/main.yml

@@ -1,46 +1,82 @@
 name: CI
+
 on: [push, pull_request]
-#  pull_request:
-#    branches:
-#      - main
-#      - develop
-#      - 'releases/**'
-#  push:
-#    branches: 
-#      - main
-#      - develop
-#      - 'v**' # temporary
-  
+
 jobs:
   ci:
     strategy:
       fail-fast: false
       matrix:
-        python-version: [3.6, 3.7, 3.8, 3.9, "3.10"]
-        poetry-version: [1.1.4]
-        os: [ubuntu-18.04, macos-latest, windows-latest]
+        # UV requires Python 3.8+ to run, but it can manage environments for older Python versions.
+        # actions/setup-python handles installing the target Python for the job.
+        python-version: ["3.6", "3.7", "3.8", "3.9", "3.10", "3.11", "3.12", "3.12"]
+        os: [ubuntu-latest, macos-latest, windows-latest]
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-python@v2
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
-      - name: Python Poetry Action
-        uses: abatilo/actions-poetry@v2.1.0
+
+      - name: Set up UV
+        uses: astral-sh/setup-uv@v1 # official action for UV
         with:
-          poetry-version: ${{ matrix.poetry-version }}
+          # Optional: Pin to a specific UV version for more deterministic builds
+          # version: "0.1.20" # Example version, check latest if pinning
+          enable-cache: true # Optional: enable UV caching for faster builds
+
       - name: Install dependencies
         run: |
-          python -m pip install --upgrade pip
-          pip install flake8 pytest
-          pip install -r requirements.txt
-          pip install -r requirements-test.txt
+          # Use --system to install into the Python environment set up by actions/setup-python.
+          uv pip install --system -e .[test,lint]
+        shell: bash
+
       - name: Flake8 linting
         run: |
-          # stop the build if there are Python syntax errors or undefined names
           python -m flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-          # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
           python -m flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
-      - name: Run python -m pytest
-        run: |
-          python -m pytest
+        shell: bash
+
+      - name: Run PyTest
+        run: python -m pytest
+        shell: bash
+
+  publish:
+    name: Build and publish to PyPI
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/html2image
+    permissions:
+      id-token: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12' # Use a recent Python for build tools
+
+      - name: Set up UV
+        uses: astral-sh/setup-uv@v1
+        with:
+          enable-cache: true
+
+      - name: Install build dependencies
+        # Ensure 'build' is listed in your pyproject.toml [project.optional-dependencies.dev]
+        # or install it explicitly here.
+        run: uv pip install --system build
+        shell: bash
+
+      - name: Build package
+        run: python -m build # This will use hatchling as defined in pyproject.toml
+        shell: bash
+
+      - name: Publish package to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

.gitignore

@@ -132,5 +132,5 @@ dmypy.json
 .vscode/
 tests_output/
 
-# .lock file not relevant for libraries
-poetry.lock 
+# uv
+uv.lock

README.md

@@ -41,12 +41,17 @@ For more information about headless modes :
 -   (Firefox) [https://developer.mozilla.org/en-US/docs/Mozilla/Firefox/Headless_mode](https://web.archive.org/web/20210604151145/https://developer.mozilla.org/en-US/docs/Mozilla/Firefox/Headless_mode)
 
 ## Installation
-HTML2Image is published on PyPI and can be installed through pip:
+HTML2Image is published on PyPI and can be installed through `pip`:
 
 ```console
 pip install --upgrade html2image
 ```
 
+Or with `uv`:
+```console
+uv pip install html2image
+```
+
 In addition to this package, at least one of the following browsers **must** be installed on your machine :
 -   Google Chrome (Windows, MacOS)
 -   Chromium Browser (Linux)
@@ -317,15 +322,6 @@ You can load and execute a python script to use the package, or simply use the C
 
 On top of that, you can also use [volumes](https://docs.docker.com/storage/volumes/) to bind a container directory to your local machine directory, allowing you to retrieve the generated images, or even load some resources (HTML, CSS or Python files).
 
-## Testing
-
-Only basic testing is available at the moment. To run tests, install the requirements (Pillow) and run PyTest at the root of the project:
-``` console
-pip install -r requirements-test.txt
-python -m pytest
-```
-
-
 ## FAQ
 
 - Can I automatically take a full page screenshot?  
@@ -339,11 +335,52 @@ python -m pytest
 
 - Can I make a cookie modal disappear?  
 **Yes and no**. **No**, because there is no options to do it magically and [extensions are not supported in headless Chrome](https://bugs.chromium.org/p/chromium/issues/detail?id=706008#c5) (The [`I don't care about cookies`](https://www.i-dont-care-about-cookies.eu/) extension would have been useful in this case). **Yes**, because you can make any element of a page disappear by retrieving its source code, modifying it as you wish, and finally screenshotting the modified source code.
+
+
+## Contributing and Local Development
+
+If you want to contribute to `html2image` or run tests locally, follow these steps:
+
+1.  **Clone the repository:**
+    ```bash
+    git clone https://github.com/vgalin/html2image.git
+    cd html2image
+    ```
+
+2.  **Install [uv](https://github.com/astral-sh/uv)** by following the installation instructions on the `uv` GitHub page.
+
+3.  **Create and activate a virtual environment:**
+    ```bash
+    uv venv
+    source .venv/bin/activate  # On Linux/macOS
+    # .\.venv\Scripts\Activate.ps1  # On Windows PowerShell
+    # .\.venv\Scripts\activate.bat  # On Windows CMD
+    ```
+
+4.  **Install dependencies (including development tools):**
+    ```bash
+    uv pip install -e .[dev]
+    ```
+    This installs the package in editable mode along with all dependencies needed for testing and linting.
+
+### Running Tests
+Only basic testing is available at the moment.
+To run the test suite:
+```console
+pytest
+```
+Or, using `uv`'s runner:
+```console
+uv run pytest
+```
+
+
+
 ## TODO List
 -   A nice CLI (currently in a WIP state).
 -   Support for other browsers, such as Firefox, once their screenshot feature becomes operational.
 -   PDF generation?
--   Contributing, issue templates, pull request template, code of conduct.
+-   Issue templates, pull request template, code of conduct.
 
 ---
 

html2image/browsers/chrome.py

@@ -185,7 +185,7 @@ class ChromeHeadless(ChromiumHeadless):
             + You can also keep the original behavior to backward compatibility by setting this to `None`.
     """
 
-    def __init__(self, executable=None, flags=None, print_command=False, disable_logging=False, use_new_headless=False,):
+    def __init__(self, executable=None, flags=None, print_command=False, disable_logging=False, use_new_headless=None,):
         super().__init__(executable=executable, flags=flags, print_command=print_command, disable_logging=disable_logging, use_new_headless=use_new_headless)
 
     @property

html2image/browsers/chrome_cdp.py

@@ -61,7 +61,7 @@ def ws(self):
         if not self._ws:
             print(f'----------- http://localhost:{self.cdp_port}/json/version')
             r = requests.get(f'http://localhost:{self.cdp_port}/json')  # TODO use page websocket instead of browser one
-            print(f'{r.json()=}')
+            print(f'{r.json()}')
             print(f'Using ws url= {r.json()[0]["webSocketDebuggerUrl"]}')
             self._ws = create_connection(r.json()[0]['webSocketDebuggerUrl'])
             print('Successfully connected to ws.')
@@ -75,7 +75,7 @@ def _id(self):
     def cdp_send(self, method, **params):
         """
         """
-        print(f'cdp_send: {method=} {params=}')
+        print(f'cdp_send: {method} {params}')
         return self.ws.send(
             json.dumps({
                 'id': self._id,
@@ -107,7 +107,7 @@ def screenshot(
         while True:
             message = json.loads(self.ws.recv())
             method = message.get('method')
-            print(f'{method=}')
+            print(f'{method}')
             if method == 'Page.loadEventFired':
                 break
 
@@ -159,11 +159,11 @@ def get_page_infos(self):
 
         while True:
             message = json.loads(self.ws.recv())
-            print(f'{message=}')
+            print(f'{message}')
             if 'result' in message and 'layoutViewport' in message['result']:
                 return message['result']
 
-    def print_pdf():
+    def print_pdf(self):
         # TODO : Page.printToPDF
         pass
 

html2image/browsers/chromium.py

@@ -26,7 +26,7 @@ class ChromiumHeadless(Browser):
             + You can also keep the original behavior to backward compatibility by setting this to `None`.
     """
 
-    def __init__(self, executable=None, flags=None, print_command=False, disable_logging=False, use_new_headless=False,):
+    def __init__(self, executable=None, flags=None, print_command=False, disable_logging=False, use_new_headless=None,):
         self.executable = executable
         if not flags:
             self.flags = [

html2image/browsers/edge.py

@@ -165,7 +165,7 @@ class EdgeHeadless(ChromiumHeadless):
             + You can also keep the original behavior to backward compatibility by setting this to `None`.
     """
 
-    def __init__(self, executable=None, flags=None, print_command=False, disable_logging=False, use_new_headless=False,):
+    def __init__(self, executable=None, flags=None, print_command=False, disable_logging=False, use_new_headless=None,):
         super().__init__(executable=executable, flags=flags, print_command=print_command, disable_logging=disable_logging, use_new_headless=use_new_headless)
 
     @property

html2image/html2image.py

@@ -408,6 +408,7 @@ def _prepare_html_string(html_body, css_style_string):
         prepared_html = f"""\
         <html>
         <head>
+          <meta charset="UTF-8">
             <style>
                 {css_style_string}
             </style>

pyproject.toml

@@ -1,41 +1,64 @@
-[tool.poetry]
+[project]
 name = "html2image"
-version = "2.0.5"
+version = "2.0.6" # todo take a look at dynamic versionning (e.g., hatch-vcs)
 description = "Package acting as a wrapper around the headless mode of existing web browsers to generate images from URLs and from HTML+CSS strings or files."
-authors = ["vgalin"]
-license = "MIT"
-
-# Added
+authors = [
+    { name = "vgalin" }
+]
+license = { file = "LICENSE" }
 readme = "README.md"
-homepage = "https://github.com/vgalin/html2image"
-repository = "https://github.com/vgalin/html2image"
+
 keywords = ["html", "css", "screenshot", "image", "chrome", "html to image", "css to image", "chromium-browser", "chromium"]
 classifiers = [
     "Development Status :: 5 - Production/Stable",
+    "License :: OSI Approved :: MIT License",
     "Programming Language :: Python :: 3 :: Only",
-    "Operating System :: Microsoft",
-    "Operating System :: Unix",
+    "Programming Language :: Python :: 3.6",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Operating System :: Microsoft :: Windows",
+    "Operating System :: POSIX :: Linux",
     "Operating System :: MacOS",
     "Topic :: Utilities",
     "Topic :: Software Development :: User Interfaces",
     "Topic :: Multimedia :: Graphics :: Graphics Conversion",
 ]
-include = [
-    "LICENSE",
+requires-python = ">=3.6"
+
+dependencies = [
+    "websocket-client~=1.0",
+    "requests",
 ]
 
-[tool.poetry.dependencies]
-python = "^3.6"
-websocket-client = "1.*"
-requests = "*"
+[project.urls]
+Homepage = "https://github.com/vgalin/html2image"
+Repository = "https://github.com/vgalin/html2image"
+Issues = "https://github.com/vgalin/html2image/issues"
+Changelog = "https://github.com/vgalin/html2image/releases"
 
-[tool.poetry.dev-dependencies]
-Pillow = "^8.2.0"
+[project.optional-dependencies]
+test = [
+    "Pillow>=8.2.0",
+    "pytest",
+]
+lint = [
+    "flake8",
+]
+dev = [
+    "html2image[test,lint]",
+    "build",
+    "twine",
+]
 
-[build-system]
-requires = ["poetry>=0.12"]
-build-backend = "poetry.masonry.api"
+[project.scripts]
+hti = "html2image:main"
+html2image = "html2image:main"
 
-[tool.poetry.scripts]
-hti = 'html2image:main'
-html2image = 'html2image:main'
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"