xlsxturbo 0.4.1__tar.gz → 0.7.0__tar.gz

{xlsxturbo-0.4.1 → xlsxturbo-0.7.0}/CHANGELOG.md

@@ -5,6 +5,49 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.7.0] - 2025-12-28
+
+### Added
+- **Column formatting with wildcards** - `column_formats` parameter for styling columns by pattern
+  - Wildcard patterns: `prefix*`, `*suffix`, `*contains*`, or exact match
+  - Format options: `bg_color`, `font_color`, `num_format`, `bold`, `italic`, `underline`, `border`
+  - Example: `column_formats={'mcpt_*': {'bg_color': '#D6EAF8', 'num_format': '0.00000', 'border': True}}`
+  - Available in both `df_to_xlsx()` and `dfs_to_xlsx()`
+  - Per-sheet column formats via options dict in `dfs_to_xlsx()`
+
+## [0.6.0] - 2025-12-08
+
+### Added
+- **Global column width cap** - `column_widths={'_all': 50}` to cap all columns at a maximum width
+  - Can be combined with specific column widths: `{0: 20, '_all': 50}` (specific overrides '_all')
+  - Works with autofit as a cap: `autofit=True, column_widths={'_all': 30}` fits then caps
+- **Table name parameter** - `table_name="MyTable"` to set custom Excel table names
+  - Invalid characters are automatically sanitized (spaces/special chars become underscores)
+  - Names starting with digits get underscore prefix (Excel requirement)
+  - Per-sheet table names in `dfs_to_xlsx()` via options dict
+- **Header styling** - `header_format={'bold': True, 'bg_color': '#4F81BD', 'font_color': 'white'}`
+  - Supported options: `bold`, `italic`, `font_color`, `bg_color`, `font_size`, `underline`
+  - Colors accept hex (`#RRGGBB`) or named colors (white, black, red, blue, etc.)
+  - Per-sheet header formats in `dfs_to_xlsx()` via options dict
+- Per-sheet options now support: `table_name`, `header_format`, `column_widths` with '_all'
+
+### Changed
+- `column_widths` parameter now accepts both integer keys (`{0: 20}`) and string keys (`{"_all": 50}`)
+
+## [0.5.0] - 2025-12-08
+
+### Added
+- **Per-sheet options for `dfs_to_xlsx()`** - override global settings per sheet
+  - Each sheet can now be a 3-tuple: `(df, sheet_name, options_dict)`
+  - Options dict supports: `header`, `autofit`, `table_style`, `freeze_panes`, `column_widths`, `row_heights`
+  - Old 2-tuple API `(df, sheet_name)` still works (backward compatible)
+  - Example: `[(df1, "Data", {"table_style": "Medium2"}), (df2, "Instructions", {"header": False})]`
+- `SheetOptions` TypedDict for type hints
+
+### Changed
+- `dfs_to_xlsx()` signature now accepts mixed tuple formats internally
+- Updated type stubs with new `SheetOptions` class and updated `dfs_to_xlsx` signature
+
 ## [0.4.1] - 2025-12-07
 
 ### Fixed
@@ -78,6 +121,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Support for custom sheet names
 - Verbose mode for progress reporting
 
+[0.7.0]: https://github.com/tstone-1/xlsxturbo/releases/tag/v0.7.0
+[0.6.0]: https://github.com/tstone-1/xlsxturbo/releases/tag/v0.6.0
+[0.5.0]: https://github.com/tstone-1/xlsxturbo/releases/tag/v0.5.0
 [0.4.1]: https://github.com/tstone-1/xlsxturbo/releases/tag/v0.4.1
 [0.4.0]: https://github.com/tstone-1/xlsxturbo/releases/tag/v0.4.0
 [0.3.0]: https://github.com/tstone-1/xlsxturbo/releases/tag/v0.3.0

{xlsxturbo-0.4.1 → xlsxturbo-0.7.0}/Cargo.lock

@@ -90,15 +90,15 @@ checksum = "812e12b5285cc515a9c72a5c1d3b6d46a19dac5acfef5265968c166106e31dd3"
 
 [[package]]
 name = "bumpalo"
-version = "3.19.0"
+version = "3.19.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "46c5e41b57b8bba42a04676d81cb89e9ee8e859a1a66f80a5a72e1cb76b34d43"
+checksum = "5dd9dc738b7a8311c7ade152424974d8115f2cdad61e8dab8dac9f2362298510"
 
 [[package]]
 name = "cc"
-version = "1.2.49"
+version = "1.2.51"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "90583009037521a116abf44494efecd645ba48b6622457080f080b85544e2215"
+checksum = "7a0aeaff4ff1a90589618835a598e545176939b97874f7abc7851caa0618f203"
 dependencies = [
  "find-msvc-tools",
  "shlex",
@@ -282,9 +282,9 @@ checksum = "37909eebbb50d72f9059c3b6d82c0463f2ff062c9e95845c43a6c9c0355411be"
 
 [[package]]
 name = "find-msvc-tools"
-version = "0.1.5"
+version = "0.1.6"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "3a3076410a55c90011c298b04d0cfa770b00fa04e1e3c97d3f6c9de105a03844"
+checksum = "645cbb3a84e60b7531617d5ae4e57f7e27308f6445f5abf653209ea76dec8dff"
 
 [[package]]
 name = "flate2"
@@ -371,9 +371,9 @@ checksum = "a6cb138bb79a146c1bd460005623e142ef0181e3d0219cb493e02f7d08a35695"
 
 [[package]]
 name = "itoa"
-version = "1.0.15"
+version = "1.0.17"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "4a5f13b858c8d314ee3e8f639011f7ccefe71f97f96e50151fb991f267928e2c"
+checksum = "92ecc6618181def0457392ccd0ee51198e065e016d1d527a7ac1b6dc7c1f09d2"
 
 [[package]]
 name = "js-sys"
@@ -451,15 +451,15 @@ checksum = "384b8ab6d37215f3c5301a95a4accb5d64aa607f1fcb26a11b5303878451b4fe"
 
 [[package]]
 name = "portable-atomic"
-version = "1.11.1"
+version = "1.13.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "f84267b20a16ea918e43c6a88433c2d54fa145c92a811b5b047ccbe153674483"
+checksum = "f89776e4d69bb58bc6993e99ffa1d11f228b839984854c7daeb5d37f87cbe950"
 
 [[package]]
 name = "proc-macro2"
-version = "1.0.103"
+version = "1.0.104"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "5ee95bc4ef87b8d5ba32e8b7714ccc834865276eab0aed5c9958d00ec45f49e8"
+checksum = "9695f8df41bb4f3d222c95a67532365f569318332d03d5f3f67f37b20e6ebdf0"
 dependencies = [
  "unicode-ident",
 ]
@@ -574,9 +574,9 @@ dependencies = [
 
 [[package]]
 name = "rustix"
-version = "1.1.2"
+version = "1.1.3"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "cd15f8a2c5551a84d56efdc1cd049089e409ac19a3072d5037a17fd70719ff3e"
+checksum = "146c9e247ccc180c1f61615433868c99f3de3ae256a30a43b49f67c2d9171f34"
 dependencies = [
  "bitflags",
  "errno",
@@ -593,9 +593,9 @@ checksum = "b39cdef0fa800fc44525c84ccb54a029961a8215f9619753635a9c0d2538d46d"
 
 [[package]]
 name = "ryu"
-version = "1.0.20"
+version = "1.0.22"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "28d3b2b1366ec20994f1fd18c3c594f05c5dd4bc44d8bb0c1c632c8d6829481f"
+checksum = "a50f4cf475b65d88e057964e0e9bb1f0aa9bbb2036dc65c64596b42932536984"
 
 [[package]]
 name = "serde_core"
@@ -625,9 +625,9 @@ checksum = "0fda2ff0d084019ba4d7c6f371c95d8fd75ce3524c3cb8fb653a3023f6323e64"
 
 [[package]]
 name = "simd-adler32"
-version = "0.3.7"
+version = "0.3.8"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "d66dc143e6b11c1eddc06d5c423cfc97062865baf299914ab64caa38182078fe"
+checksum = "e320a6c5ad31d271ad523dcf3ad13e2767ad8b1cb8f047f75a8aeaf8da139da2"
 
 [[package]]
 name = "strsim"
@@ -654,9 +654,9 @@ checksum = "61c41af27dd6d1e27b1b16b489db798443478cef1f06a660c96db617ba5de3b1"
 
 [[package]]
 name = "tempfile"
-version = "3.23.0"
+version = "3.24.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "2d31c77bdf42a745371d260a26ca7163f1e0924b64afa0b688e61b5a9fa02f16"
+checksum = "655da9c7eb6305c55742045d5a8d2037996d61d8de95806335c7c86ce0f82e9c"
 dependencies = [
  "fastrand",
  "getrandom",
@@ -833,7 +833,7 @@ checksum = "f17a85883d4e6d00e8a97c586de764dabcc06133f7f1d55dce5cdc070ad7fe59"
 
 [[package]]
 name = "xlsxturbo"
-version = "0.4.1"
+version = "0.7.0"
 dependencies = [
  "chrono",
  "clap",

{xlsxturbo-0.4.1 → xlsxturbo-0.7.0}/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "xlsxturbo"
-version = "0.4.1"
+version = "0.7.0"
 edition = "2021"
 description = "High-performance Excel writer with automatic type detection (pandas, polars, CSV)"
 license = "MIT"

{xlsxturbo-0.4.1 → xlsxturbo-0.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xlsxturbo
-Version: 0.4.1
+Version: 0.7.0
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Science/Research
@@ -40,10 +40,13 @@ High-performance Excel writer with automatic type detection. Written in Rust, us
 - **Direct DataFrame support** for pandas and polars
 - **Excel tables** - filterable tables with 61 built-in styles (banded rows, autofilter)
 - **Auto-fit columns** - automatically adjust column widths to fit content
-- **Custom column widths** - set specific widths per column
+- **Custom column widths** - set specific widths per column or cap all with _all
+- **Header styling** - bold, colors, font size for header row
+- **Named tables** - set custom table names
 - **Custom row heights** - set specific heights per row
 - **Freeze panes** - freeze header row for easier scrolling
 - **Multi-sheet workbooks** - write multiple DataFrames to one file
+- **Per-sheet options** - override settings per sheet in multi-sheet workbooks
 - **Constant memory mode** - minimize RAM usage for very large files
 - **Parallel CSV processing** - optional multi-core parsing for large files
 - **Automatic type detection** from CSV strings and Python objects:
@@ -150,6 +153,83 @@ xlsxturbo.df_to_xlsx(df, "styled.xlsx",
 )
 ```
 
+### Global Column Width Cap
+
+Use `column_widths={'_all': value}` to cap all columns at a maximum width:
+
+```python
+import xlsxturbo
+import pandas as pd
+
+df = pd.DataFrame({
+    'Name': ['Alice', 'Bob'],
+    'VeryLongDescription': ['A' * 100, 'B' * 100],
+    'Score': [95, 87]
+})
+
+# Cap all columns at 30 characters
+xlsxturbo.df_to_xlsx(df, "capped.xlsx", column_widths={'_all': 30})
+
+# Mix specific widths with global cap (specific overrides '_all')
+xlsxturbo.df_to_xlsx(df, "mixed.xlsx", column_widths={0: 15, '_all': 30})
+
+# Autofit with cap: fit content, but never exceed 25 characters
+xlsxturbo.df_to_xlsx(df, "fitted.xlsx", autofit=True, column_widths={'_all': 25})
+```
+
+### Named Excel Tables
+
+Set custom names for Excel tables:
+
+```python
+import xlsxturbo
+import pandas as pd
+
+df = pd.DataFrame({'Product': ['A', 'B'], 'Price': [10, 20]})
+
+# Name the Excel table
+xlsxturbo.df_to_xlsx(df, "report.xlsx", 
+    table_style="Medium2", 
+    table_name="ProductPrices"
+)
+
+# Invalid characters are auto-sanitized, digits get underscore prefix
+xlsxturbo.df_to_xlsx(df, "report.xlsx",
+    table_style="Medium2",
+    table_name="2024 Sales Data!"  # Becomes "_2024_Sales_Data_"
+)
+```
+
+### Header Styling
+
+Apply custom formatting to header cells:
+
+```python
+import xlsxturbo
+import pandas as pd
+
+df = pd.DataFrame({'Name': ['Alice', 'Bob'], 'Score': [95, 87]})
+
+# Bold headers
+xlsxturbo.df_to_xlsx(df, "bold.xlsx", header_format={'bold': True})
+
+# Full styling with colors
+xlsxturbo.df_to_xlsx(df, "styled.xlsx", header_format={
+    'bold': True,
+    'bg_color': '#4F81BD',   # Blue background
+    'font_color': 'white'    # White text
+})
+
+# Available options:
+# - bold (bool): Bold text
+# - italic (bool): Italic text
+# - font_color (str): '#RRGGBB' or named color (white, black, red, blue, etc.)
+# - bg_color (str): Background color
+# - font_size (float): Font size in points
+# - underline (bool): Underlined text
+```
+
+
 ### Multi-Sheet Workbooks
 
 ```python
@@ -178,6 +258,42 @@ xlsxturbo.dfs_to_xlsx([
 ], "report.xlsx", column_widths={0: 20, 1: 15})
 ```
 
+### Per-Sheet Options
+
+Override global settings for individual sheets using a 3-tuple with options dict:
+
+```python
+import xlsxturbo
+import pandas as pd
+
+df_data = pd.DataFrame({'Product': ['A', 'B'], 'Price': [10, 20]})
+df_instructions = pd.DataFrame({'Step': [1, 2], 'Action': ['Open file', 'Review data']})
+
+# Different settings per sheet:
+# - "Data" sheet: has header, table style, autofit
+# - "Instructions" sheet: no header (raw data), no table style
+xlsxturbo.dfs_to_xlsx([
+    (df_data, "Data", {"header": True, "table_style": "Medium2"}),
+    (df_instructions, "Instructions", {"header": False, "table_style": None})
+], "report.xlsx", autofit=True)
+
+# Old 2-tuple API still works - uses global defaults
+xlsxturbo.dfs_to_xlsx([
+    (df_data, "Sheet1"),  # Uses global header=True, table_style=None
+    (df_instructions, "Sheet2", {"header": False})  # Override just header
+], "mixed.xlsx", header=True, autofit=True)
+```
+
+Available per-sheet options:
+- `header` (bool): Include column names as header row
+- `autofit` (bool): Automatically adjust column widths
+- `table_style` (str|None): Excel table style or None to disable
+- `freeze_panes` (bool): Freeze header row
+- `column_widths` (dict): Custom column widths
+- `row_heights` (dict): Custom row heights
+- `table_name` (str): Custom Excel table name
+- `header_format` (dict): Header cell styling
+
 ### Constant Memory Mode (Large Files)
 
 For very large files (millions of rows), use `constant_memory=True` to minimize RAM usage:

{xlsxturbo-0.4.1 → xlsxturbo-0.7.0}/README.md

@@ -7,10 +7,13 @@ High-performance Excel writer with automatic type detection. Written in Rust, us
 - **Direct DataFrame support** for pandas and polars
 - **Excel tables** - filterable tables with 61 built-in styles (banded rows, autofilter)
 - **Auto-fit columns** - automatically adjust column widths to fit content
-- **Custom column widths** - set specific widths per column
+- **Custom column widths** - set specific widths per column or cap all with _all
+- **Header styling** - bold, colors, font size for header row
+- **Named tables** - set custom table names
 - **Custom row heights** - set specific heights per row
 - **Freeze panes** - freeze header row for easier scrolling
 - **Multi-sheet workbooks** - write multiple DataFrames to one file
+- **Per-sheet options** - override settings per sheet in multi-sheet workbooks
 - **Constant memory mode** - minimize RAM usage for very large files
 - **Parallel CSV processing** - optional multi-core parsing for large files
 - **Automatic type detection** from CSV strings and Python objects:
@@ -117,6 +120,83 @@ xlsxturbo.df_to_xlsx(df, "styled.xlsx",
 )
 ```
 
+### Global Column Width Cap
+
+Use `column_widths={'_all': value}` to cap all columns at a maximum width:
+
+```python
+import xlsxturbo
+import pandas as pd
+
+df = pd.DataFrame({
+    'Name': ['Alice', 'Bob'],
+    'VeryLongDescription': ['A' * 100, 'B' * 100],
+    'Score': [95, 87]
+})
+
+# Cap all columns at 30 characters
+xlsxturbo.df_to_xlsx(df, "capped.xlsx", column_widths={'_all': 30})
+
+# Mix specific widths with global cap (specific overrides '_all')
+xlsxturbo.df_to_xlsx(df, "mixed.xlsx", column_widths={0: 15, '_all': 30})
+
+# Autofit with cap: fit content, but never exceed 25 characters
+xlsxturbo.df_to_xlsx(df, "fitted.xlsx", autofit=True, column_widths={'_all': 25})
+```
+
+### Named Excel Tables
+
+Set custom names for Excel tables:
+
+```python
+import xlsxturbo
+import pandas as pd
+
+df = pd.DataFrame({'Product': ['A', 'B'], 'Price': [10, 20]})
+
+# Name the Excel table
+xlsxturbo.df_to_xlsx(df, "report.xlsx", 
+    table_style="Medium2", 
+    table_name="ProductPrices"
+)
+
+# Invalid characters are auto-sanitized, digits get underscore prefix
+xlsxturbo.df_to_xlsx(df, "report.xlsx",
+    table_style="Medium2",
+    table_name="2024 Sales Data!"  # Becomes "_2024_Sales_Data_"
+)
+```
+
+### Header Styling
+
+Apply custom formatting to header cells:
+
+```python
+import xlsxturbo
+import pandas as pd
+
+df = pd.DataFrame({'Name': ['Alice', 'Bob'], 'Score': [95, 87]})
+
+# Bold headers
+xlsxturbo.df_to_xlsx(df, "bold.xlsx", header_format={'bold': True})
+
+# Full styling with colors
+xlsxturbo.df_to_xlsx(df, "styled.xlsx", header_format={
+    'bold': True,
+    'bg_color': '#4F81BD',   # Blue background
+    'font_color': 'white'    # White text
+})
+
+# Available options:
+# - bold (bool): Bold text
+# - italic (bool): Italic text
+# - font_color (str): '#RRGGBB' or named color (white, black, red, blue, etc.)
+# - bg_color (str): Background color
+# - font_size (float): Font size in points
+# - underline (bool): Underlined text
+```
+
+
 ### Multi-Sheet Workbooks
 
 ```python
@@ -145,6 +225,42 @@ xlsxturbo.dfs_to_xlsx([
 ], "report.xlsx", column_widths={0: 20, 1: 15})
 ```
 
+### Per-Sheet Options
+
+Override global settings for individual sheets using a 3-tuple with options dict:
+
+```python
+import xlsxturbo
+import pandas as pd
+
+df_data = pd.DataFrame({'Product': ['A', 'B'], 'Price': [10, 20]})
+df_instructions = pd.DataFrame({'Step': [1, 2], 'Action': ['Open file', 'Review data']})
+
+# Different settings per sheet:
+# - "Data" sheet: has header, table style, autofit
+# - "Instructions" sheet: no header (raw data), no table style
+xlsxturbo.dfs_to_xlsx([
+    (df_data, "Data", {"header": True, "table_style": "Medium2"}),
+    (df_instructions, "Instructions", {"header": False, "table_style": None})
+], "report.xlsx", autofit=True)
+
+# Old 2-tuple API still works - uses global defaults
+xlsxturbo.dfs_to_xlsx([
+    (df_data, "Sheet1"),  # Uses global header=True, table_style=None
+    (df_instructions, "Sheet2", {"header": False})  # Override just header
+], "mixed.xlsx", header=True, autofit=True)
+```
+
+Available per-sheet options:
+- `header` (bool): Include column names as header row
+- `autofit` (bool): Automatically adjust column widths
+- `table_style` (str|None): Excel table style or None to disable
+- `freeze_panes` (bool): Freeze header row
+- `column_widths` (dict): Custom column widths
+- `row_heights` (dict): Custom row heights
+- `table_name` (str): Custom Excel table name
+- `header_format` (dict): Header cell styling
+
 ### Constant Memory Mode (Large Files)
 
 For very large files (millions of rows), use `constant_memory=True` to minimize RAM usage:

{xlsxturbo-0.4.1 → xlsxturbo-0.7.0}/ROADMAP.md

@@ -9,21 +9,21 @@ Features that would enable more migrations from pandas/polars write_excel.
 - [x] **Column auto-width** - Automatically fit column widths to content (v0.3.0)
 - [x] **Custom column widths** - Set specific widths per column (v0.4.0)
 - [x] **Custom row heights** - Set specific heights per row (v0.4.0)
-- [ ] **Per-sheet options in dfs_to_xlsx** - Allow different settings per sheet
-  - Currently all sheets share the same header/autofit/table_style/freeze_panes
-  - API idea: `sheets=[(df1, "Sheet1", {"header": True}), (df2, "Sheet2", {"header": False})]`
-- [ ] **Header styling** - Option for bold/colored headers (`header_format` parameter)
+- [x] **Per-sheet options in dfs_to_xlsx** - Allow different settings per sheet (v0.5.0)
+- [x] **Header styling** - Option for bold/colored headers (`header_format` parameter) (v0.6.0)
 - [x] **Freeze panes** - Freeze header row for easier scrolling (v0.3.0)
-- [ ] **Global column width cap** - `column_widths={'_all': value}` to limit all column widths
-- [ ] **Table name** - `table_name` parameter for named Excel tables
+- [x] **Global column width cap** - `column_widths={'_all': value}` to limit all column widths (v0.6.0)
+- [x] **Table name** - `table_name` parameter for named Excel tables (v0.6.0)
 
 ## Medium Priority
 
 Power user features for more control over output.
 
 - [x] **Multi-core support** - Parallel CSV parsing with rayon (~7% speedup for large files)
-- [ ] **Cell formatting options** - Custom number/date formats per column
-- [ ] **Cell styling** - Background color, font color, bold, borders per cell/column
+- [x] **Column formatting with wildcards** - `column_formats` with pattern matching (v0.7.0)
+  - Supports: `prefix*`, `*suffix`, `*contains*`, exact match
+  - Format options: bg_color, font_color, num_format, bold, italic, underline, border
+- [ ] **Row-level cell formatting** - Conditional styling based on cell values
 - [ ] **Merged cells** - Merge cell ranges for headers/documentation sheets
 - [ ] **Conditional formatting** - Color scales, data bars, icon sets
 - [x] **Table styles** - Create Excel tables with auto-filters and 61 built-in styles (v0.3.0)
@@ -40,6 +40,10 @@ Niche features for specific use cases.
 
 ## Completed
 
+- [x] Column formatting with wildcards via `column_formats` parameter (v0.7.0)
+- [x] Global column width cap with `column_widths={'_all': value}` (v0.6.0)
+- [x] Table name parameter with `table_name` (v0.6.0)
+- [x] Header styling with `header_format` (v0.6.0)
 - [x] CSV to XLSX conversion with type detection (v0.1.0)
 - [x] pandas DataFrame support (v0.2.0)
 - [x] polars DataFrame support (v0.2.0)
@@ -50,3 +54,4 @@ Niche features for specific use cases.
 - [x] Custom column widths with `column_widths` parameter (v0.4.0)
 - [x] Custom row heights with `row_heights` parameter (v0.4.0)
 - [x] Constant memory mode with `constant_memory` parameter (v0.4.0)
+- [x] Per-sheet options in `dfs_to_xlsx()` (v0.5.0)

{xlsxturbo-0.4.1 → xlsxturbo-0.7.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "maturin"
 
 [project]
 name = "xlsxturbo"
-version = "0.4.1"
+version = "0.7.0"
 description = "High-performance Excel writer with automatic type detection (pandas, polars, CSV)"
 readme = "README.md"
 license = { text = "MIT" }

xlsxturbo-0.7.0/python/xlsxturbo/__init__.pyi

@@ -0,0 +1,118 @@
+"""Type stubs for xlsxturbo"""
+
+from typing import TypedDict
+
+class HeaderFormat(TypedDict, total=False):
+    """Header cell formatting options. All fields are optional."""
+    bold: bool
+    italic: bool
+    font_color: str  # '#RRGGBB' or named color (white, black, red, blue, etc.)
+    bg_color: str    # '#RRGGBB' or named color
+    font_size: float
+    underline: bool
+
+class SheetOptions(TypedDict, total=False):
+    """Per-sheet options for dfs_to_xlsx. All fields are optional."""
+    header: bool
+    autofit: bool
+    table_style: str | None
+    freeze_panes: bool
+    column_widths: dict[int | str, float] | None  # Keys: int index or '_all'
+    row_heights: dict[int, float] | None
+    table_name: str | None
+    header_format: HeaderFormat | None
+
+def csv_to_xlsx(
+    input_path: str,
+    output_path: str,
+    sheet_name: str = "Sheet1",
+    parallel: bool = False,
+) -> tuple[int, int]:
+    """
+    Convert a CSV file to XLSX format with automatic type detection.
+
+    Args:
+        input_path: Path to the input CSV file
+        output_path: Path for the output XLSX file
+        sheet_name: Name of the worksheet (default: "Sheet1")
+        parallel: Use multi-core parallel processing (default: False).
+                  Faster for large files (100K+ rows) but uses more memory.
+
+    Returns:
+        Tuple of (rows, columns) written to the Excel file
+
+    Raises:
+        ValueError: If the conversion fails
+    """
+    ...
+
+def df_to_xlsx(
+    df: object,
+    output_path: str,
+    sheet_name: str = "Sheet1",
+    header: bool = True,
+    autofit: bool = False,
+    table_style: str | None = None,
+    freeze_panes: bool = False,
+    column_widths: dict[int | str, float] | None = None,
+    row_heights: dict[int, float] | None = None,
+    constant_memory: bool = False,
+    table_name: str | None = None,
+    header_format: HeaderFormat | None = None,
+) -> tuple[int, int]:
+    """
+    Convert a pandas or polars DataFrame to XLSX format.
+
+    Args:
+        df: pandas DataFrame or polars DataFrame to export
+        output_path: Path for the output XLSX file
+        sheet_name: Name of the worksheet (default: "Sheet1")
+        header: Include column names as header row (default: True)
+        autofit: Automatically adjust column widths to fit content (default: False)
+        table_style: Apply Excel table formatting (default: None).
+            Styles: "Light1"-"Light21", "Medium1"-"Medium28", "Dark1"-"Dark11", "None".
+        freeze_panes: Freeze the header row for easier scrolling (default: False)
+        column_widths: Dict mapping column index to width. Use '_all' to cap all columns.
+        row_heights: Dict mapping row index to height in points.
+        constant_memory: Use streaming mode for minimal RAM usage (default: False).
+        table_name: Custom name for the Excel table (requires table_style).
+        header_format: Dict of header cell formatting options.
+    """
+    ...
+
+def dfs_to_xlsx(
+    sheets: list[tuple[object, str] | tuple[object, str, SheetOptions]],
+    output_path: str,
+    header: bool = True,
+    autofit: bool = False,
+    table_style: str | None = None,
+    freeze_panes: bool = False,
+    column_widths: dict[int | str, float] | None = None,
+    row_heights: dict[int, float] | None = None,
+    constant_memory: bool = False,
+    table_name: str | None = None,
+    header_format: HeaderFormat | None = None,
+) -> list[tuple[int, int]]:
+    """
+    Write multiple DataFrames to separate sheets in a single workbook.
+
+    Args:
+        sheets: List of (DataFrame, sheet_name) or (DataFrame, sheet_name, options) tuples.
+        output_path: Path for the output XLSX file
+        header: Include column names as header row (default: True)
+        autofit: Automatically adjust column widths (default: False)
+        table_style: Apply Excel table formatting (default: None).
+        freeze_panes: Freeze the header row (default: False)
+        column_widths: Dict mapping column index to width. Use '_all' to cap all columns.
+        row_heights: Dict mapping row index to height in points.
+        constant_memory: Use streaming mode (default: False).
+        table_name: Custom name for Excel tables (requires table_style).
+        header_format: Dict of header cell formatting options.
+    """
+    ...
+
+def version() -> str:
+    """Get the version of the xlsxturbo library."""
+    ...
+
+__version__: str