Enhance CLI and core functionality with improved resolution and rendering support

- Updated CLI to support more flexible resolution handling
- Added support for screen and print media resolution types
- Introduced new resolution classes: ScreenResolution and PrintMediaResolution
- Enhanced render timeout and scale factor handling
- Updated tests to cover new CLI and core functionality
- Bumped version to 0.6.0 to reflect significant changes
- Added Pydantic as a dependency for improved type validation
- Simplified CLI argument parsing and processing
- Improved error handling and parameter flexibility

Author: Nutchanon Ninyawee

.mise.toml

@@ -38,7 +38,7 @@ run = "uv run ruff check snap_html/ tests/"
 
 [tasks.build]
 description = "Build package"
-sources = ["snap_html"]
+sources = ["snap_html/**/*.py", "pyproject.toml", "README.md", "LICENSE"]
 outputs = ["dist"]
 run = "rm -rf dist && uv build"
 

CHANGELOG.md

@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.5.1] - 2023-10-15
+
 ### Added
 
 - Command Line Interface (CLI) for capturing screenshots
@@ -15,16 +17,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - New PrintMediaResolution type that combines pixel and CM dimensions
 - Object-fit options (contain, cover, fill, none) for controlling how content fits in viewport
 - Optional resolution parameter with sensible defaults
+- CLI support for render_timeout parameter to control waiting for RENDER_COMPLETE signal
+- CLI support for object_fit parameter to control content fitting
 
 ### Fixed
 
 - Fixed unit conversion in UnitConverter class to properly handle Pint quantity objects
 - Improved DPI and resolution handling for more accurate image sizing
 - Fixed type checking issues with resolution parameters
+- Fixed type handling in CLI for better compatibility with the core functions
+- Improved error handling in CLI for nonexistent files
 
 ### Changed
 
 - Adjusted default device scale factor to 1.5 (150% zoom) for better image quality
 - Modified resolution handling to support both screen and print media dimensions
 - Made resolution parameter optional with sensible defaults
 - Made object_fit parameter optional with a default value of "contain"
+- Updated CLI tests to properly test all parameters and edge cases

README.md

@@ -263,7 +263,16 @@ screenshot = generate_image_sync(
         "dpi": 300,
         "object_fit": "contain"
     },
-    scale_factor=1.5  # Increase zoom level for sharper text
+    scale_factor=1.5,  # Increase zoom level for sharper text
+    render_timeout=10.0  # Wait up to 10 seconds for RENDER_COMPLETE signal
+)
+
+# Using object_fit as a separate parameter
+screenshot = generate_image_sync(
+    "https://www.example.com",
+    resolution={"width": 1920, "height": 1080},
+    object_fit="cover",  # Content will cover the entire viewport
+    scale_factor=1.5
 )
 ```
 
@@ -309,19 +318,19 @@ If the `RENDER_COMPLETE` signal is not received within the specified timeout, sn
 
 ```bash
 # Basic usage with pixel dimensions
-snap-html capture https://example.com -o screenshot.png --width 1920 --height 1080
+snap-html https://example.com -o screenshot.png --width 1920 --height 1080
 
 # Using physical dimensions (e.g., A4 paper size)
-snap-html capture input.html --cm-width 21.0 --cm-height 29.7 --dpi 300 -o output.png
+snap-html input.html --cm-width 21.0 --cm-height 29.7 --dpi 300 -o output.png
 
 # Capture with custom scale factor
-snap-html capture https://example.com -o screenshot.png --width 1024 --height 768 --scale 2.0
+snap-html https://example.com -o screenshot.png --width 1024 --height 768 --scale 2.0
 
 # Using both pixel and physical dimensions with object-fit
-snap-html capture https://example.com -o screenshot.png --width 1920 --height 1080 --cm-width 21.0 --cm-height 29.7 --object-fit cover
+snap-html https://example.com -o screenshot.png --width 1920 --height 1080 --cm-width 21.0 --cm-height 29.7 --object-fit cover
 
 # Wait for RENDER_COMPLETE signal with custom timeout
-snap-html capture https://example.com -o screenshot.png --render-timeout 15.0
+snap-html https://example.com -o screenshot.png --timeout 15.0
 ```
 
 **Available Options**:
@@ -333,8 +342,8 @@ snap-html capture https://example.com -o screenshot.png --render-timeout 15.0
   --cm-height FLOAT         Output height in centimeters
   --dpi INTEGER             DPI for cm-based resolution [default: 300]
   --scale FLOAT             Browser scale factor (zoom level) [default: 1.5]
-  --object-fit TEXT         How content fits viewport: contain, cover, fill, none [default: contain]
-  --render-timeout FLOAT    Time to wait for RENDER_COMPLETE signal (in seconds) [default: 10.0]
+  --timeout FLOAT           Time to wait for RENDER_COMPLETE signal (in seconds)
+  --object-fit TEXT         How content fits viewport: contain, cover, fill, none
   --help                    Show this message and exit.
 ```
 

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "snap-html"
-version = "0.5.0"
+version = "0.6.0"
 description = "a robust, modern and high performance Python library for generating image from a html string/html file/url build on top of `playwright`"
 authors = [{ name = "codustry", email = "[email protected]" }]
 requires-python = "~=3.8"
@@ -20,6 +20,7 @@ dependencies = [
     "furl>=2.1.0",
     "pint>=0.21.1",
     "pytest>=6.2.5",
+    "pydantic>=2.10.6",
 ]
 
 [project.urls]
@@ -89,8 +90,6 @@ exclude = [
     "venv",
 ]
 
-[tool.ruff.lint]
-docstring-code-line-length = "dynamic"
 
 [tool.ruff.lint.per-file-ignores]
 "__init__.py" = ["E402"]