https://github.com/rahmadafandi/rustpy-xlsxwriter
Rust Python bindings for rust_xlsxwriter
https://github.com/rahmadafandi/rustpy-xlsxwriter
maturin pyo3 python python-3 rust xlsx xlsxwriter
Last synced: 3 months ago
JSON representation
Rust Python bindings for rust_xlsxwriter
- Host: GitHub
- URL: https://github.com/rahmadafandi/rustpy-xlsxwriter
- Owner: rahmadafandi
- License: mit
- Created: 2025-01-01T01:05:38.000Z (4 months ago)
- Default Branch: master
- Last Pushed: 2025-01-09T02:03:50.000Z (4 months ago)
- Last Synced: 2025-01-18T03:13:06.651Z (4 months ago)
- Topics: maturin, pyo3, python, python-3, rust, xlsx, xlsxwriter
- Language: Rust
- Homepage: https://pypi.org/project/rustpy-xlsxwriter/
- Size: 50.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# RustPy-XlsxWriter
RustPy-XlsxWriter is a high-performance library for generating Excel files in Python, powered by Rust and integrated using PyO3. This library is ideal for creating Excel files with large datasets efficiently while maintaining a simple and Pythonic interface.
## Installation
Install RustPy-XlsxWriter via pip:
```bash
pip install rustpy-xlsxwriter
```
## Features
- Create Excel files quickly and efficiently.
- Support for single and multi-threaded record saving.
- Save data into multiple sheets.
- Optionally protect Excel files with passwords.
## API Reference
Below is the API provided by `rustpy_xlsxwriter`:
### `get_version()`
```python
from rustpy_xlsxwriter import get_version
def get_version() -> str:
"""
Get the version of the RustPy-XlsxWriter library.
Returns:
str: The version string.
"""
```
### `save_records()`
```python
from rustpy_xlsxwriter import save_records
def save_records(
records: List[Dict[str, str]],
file_name: str,
sheet_name: Optional[str] = None,
password: Optional[str] = None,
):
"""
Save records to a single sheet in an Excel file.
Args:
records (List[Dict[str, str]]): A list of dictionaries containing data to save.
file_name (str): The name of the Excel file to create.
sheet_name (Optional[str], optional): The name of the sheet. Defaults to None.
password (Optional[str], optional): The password to protect the file. Defaults to None.
"""
```
### `save_records_multiple_sheets()`
```python
from rustpy_xlsxwriter import save_records_multiple_sheets
def save_records_multiple_sheets(
records_with_sheet_name: List[Dict[str, List[Dict[str, str]]]],
file_name: str,
password: Optional[str] = None,
):
"""
Save records to multiple sheets in an Excel file.
Args:
records_with_sheet_name (List[Dict[str, List[Dict[str, str]]]]): A list of dictionaries with sheet names as keys and record lists as values.
file_name (str): The name of the Excel file to create.
password (Optional[str], optional): The password to protect the file. Defaults to None.
"""
```
## Performance
Based on the performance test results:
| Operation | Records | Time (seconds) |
|-----------|---------|----------------|
| Single Sheet | 1,000,000 | ~4.68s |
| Multiple Sheets | 1,000,000 | ~5.31s |
| Python xlsxwriter | 1,000,000 | ~16.38s |
Key findings:
- The Rust implementation is approximately 3.5x faster than Python's xlsxwriter library for processing 1 million records (4.68s vs 16.38s)
- Single-sheet performance shows consistent timing around 4.7 seconds for 1 million records
- Multiple sheets operation takes ~5.31 seconds for 1,000 records per sheet (1000 sheets total)
The significant performance improvement over Python's xlsxwriter is due to:
1. Rust's efficient memory management and ownership model
2. Direct compilation to optimized native machine code
3. Zero-cost abstractions in Rust that provide high-level features without runtime overhead
## Usage Examples
### Save Records to a Single Sheet
```python
from rustpy_xlsxwriter import save_records
records = [
{"Name": "Alice", "Age": "30", "City": "New York"},
{"Name": "Bob", "Age": "25", "City": "San Francisco"},
]
save_records(records, "output.xlsx", sheet_name="Sheet1")
```
### Save Records to Multiple Sheets
```python
from rustpy_xlsxwriter import save_records_multiple_sheets
records_with_sheet_name = [
{"Sheet1": [
{"Name": "Alice", "Age": "30", "City": "New York"},
{"Name": "Bob", "Age": "25", "City": "San Francisco"},
]},
{"Sheet2": [
{"Product": "Laptop", "Price": "1000", "Stock": "50"},
{"Product": "Phone", "Price": "500", "Stock": "100"},
]},
]
save_records_multiple_sheets(records_with_sheet_name, "output_multiple_sheets.xlsx")
```
## Contributing
Contributions are welcome! Please submit issues or pull requests on the [GitHub repository](https://github.com/rahmadafandi/rustpy-xlsxwriter).
## License
This project is licensed under the MIT .
## Acknowledgements
This project is inspired by [Rust-XlsxWriter](https://github.com/jmcnamara/rust_xlsxwriter) and [PyO3](https://github.com/pyo3/pyo3) with the help of [maturin](https://github.com/PyO3/maturin).
## Contributors
- [Rahmad Afandi](https://github.com/rahmadafandi)