add own readme to plotly_static

Signed-off-by: Andrei Gherghescu <[email protected]>

Author: andrei-ng

CHANGELOG.md

@@ -24,6 +24,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 - [[#314](https://github.com/plotly/plotly.rs/pull/314)] Add axis range bounds support
 - [[#317](https://github.com/plotly/plotly.rs/pull/317)] Show rangebreak usage with ints
 - [[#318](https://github.com/plotly/plotly.rs/pull/318)] Add slider support
+- [[#319](https://github.com/plotly/plotly.rs/pull/319)] Introduce `plotly_static` package for static export of plots using WebDriver driven browsers 
+
 
 ### Fixed
 - [[#284](https://github.com/plotly/plotly.rs/pull/284)]  Allow plotly package to be compiled for android 

plotly_static/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Plotly, Inc
+
+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.

plotly_static/README.md

@@ -0,0 +1,158 @@
+# plotly_static
+
+Export Plotly plots to static images using WebDriver and headless browsers.
+
+## Overview
+
+`plotly_static` provides a Rust interface for converting Plotly plots from JSON data into various static image formats (PNG, JPEG, WEBP, SVG, PDF) using WebDriver and headless browsers.
+
+## Features
+
+- **Multiple Formats**: PNG, JPEG, WEBP, SVG, PDF
+- **Browser Support**: Chrome/Chromium (chromedriver) and Firefox (geckodriver)
+- **Efficient**: Reuse `StaticExporter` instances for multiple exports
+- **String Export**: Base64 and SVG output for web applications
+- **Parallel Safe**: Designed for concurrent usage
+- **Automatic Management**: Handles WebDriver lifecycle and cleanup
+
+## Quick Start
+
+```rust
+use plotly_static::{StaticExporterBuilder, ImageFormat};
+use serde_json::json;
+use std::path::Path;
+
+// Create a simple plot as JSON
+let plot = json!({
+    "data": [{
+        "type": "scatter",
+        "x": [1, 2, 3, 4],
+        "y": [10, 11, 12, 13]
+    }],
+    "layout": {
+        "title": "Simple Scatter Plot"
+    }
+});
+
+// Build and use StaticExporter
+let mut exporter = StaticExporterBuilder::default()
+    .build()
+    .expect("Failed to build StaticExporter");
+
+// Export to PNG
+exporter.write_fig(
+    Path::new("my_plot"),
+    &plot,
+    ImageFormat::PNG,
+    800,
+    600,
+    1.0
+).expect("Failed to export plot");
+```
+
+## Usage
+
+Add to your `Cargo.toml`:
+
+```toml
+[dependencies]
+plotly_static = { version = "0.0.1", features = ["chromedriver", "webdriver_download"] }
+serde_json = "1.0"
+```
+
+### Feature Flags
+
+- `chromedriver`: Use Chromedriver and Chrome/Chromium browser for rendering and export
+- `geckodriver`: Use Geckodriver Firefox browser for rendering for rendering and export
+- `webdriver_download`: Auto-download the chosen WebDriver binary
+
+## Prerequisites
+
+1. **Browser**: Chrome/Chromium or Firefox installed
+2. **WebDriver**: Manually installed or automatically downloaded and installed with the `webdriver_download` feature
+3. **Internet Connectivity**: Required for WebDriver download when using the auto-download and install feature
+
+## Advanced Usage
+
+### Static Exporter Reuse
+
+```rust
+use plotly_static::{StaticExporterBuilder, ImageFormat};
+use serde_json::json;
+use std::path::Path;
+
+let plot1 = json!({
+    "data": [{"type": "scatter", "x": [1,2,3], "y": [4,5,6]}],
+    "layout": {"title": "Plot 1"}
+});
+
+let plot2 = json!({
+    "data": [{"type": "scatter", "x": [2,3,4], "y": [5,6,7]}],
+    "layout": {"title": "Plot 2"}
+});
+
+let mut exporter = StaticExporterBuilder::default()
+    .build()
+    .expect("Failed to create StaticExporter");
+
+// Reuse for multiple exports
+exporter.write_fig(Path::new("plot1"), &plot1, ImageFormat::PNG, 800, 600, 1.0)?;
+exporter.write_fig(Path::new("plot2"), &plot2, ImageFormat::JPEG, 800, 600, 1.0)?;
+```
+
+### String Export
+
+```rust
+use plotly_static::{StaticExporterBuilder, ImageFormat};
+use serde_json::json;
+
+let plot = json!({
+    "data": [{"type": "scatter", "x": [1,2,3], "y": [4,5,6]}],
+    "layout": {}
+});
+
+let mut exporter = StaticExporterBuilder::default()
+    .build()
+    .expect("Failed to create StaticExporter");
+
+// Get base64 data for web embedding
+let base64_data = exporter.write_to_string(&plot, ImageFormat::PNG, 400, 300, 1.0)?;
+
+// Get SVG data (vector format)
+let svg_data = exporter.write_to_string(&plot, ImageFormat::SVG, 400, 300, 1.0)?;
+```
+
+### Custom Configuration
+
+```rust
+use plotly_static::StaticExporterBuilder;
+
+let mut exporter = StaticExporterBuilder::default()
+    .webdriver_port(4445)  // Unique port for parallel usage
+    .offline_mode(true)    // Use bundled JavaScript
+    .webdriver_browser_caps(vec![
+        "--headless".to_string(),
+        "--no-sandbox".to_string(),
+    ])
+    .build()?;
+```
+
+## Environment Variables
+
+- `WEBDRIVER_PATH`: Custom WebDriver binary location
+- `BROWSER_PATH`: Custom browser binary location
+
+## Examples
+
+Check the self contatined examples in the examples folder. 
+
+Similar examples are available in the [Plotly.rs package](https://github.com/plotly/plotly.rs), in [Plotly.rs Book](https://plotly.github.io/plotly.rs/) as well as the example in [Plotly.rs examples/static_export](https://github.com/plotly/plotly.rs/tree/main/examples/static_export).
+
+## Documentation
+
+- [API Documentation](https://docs.rs/plotly_static/)
+- [Static Image Export Guide](../../docs/book/src/fundamentals/static_image_export.md)
+
+## License
+
+This package is licensed under the MIT License.