pyfastexcel 0.1.8

High performace excel file generation library.

pyfastexcel

This package enables high-performance Excel writing by integrating with the streaming API from the golang package excelize. Users can leverage this functionality without the need to write any Go code, as the entire process can be accomplished through Python.

Features

• Python and Golang Integration: Seamlessly call Golang built shared libraries from Python.

• No Golang Code Required: Users can solely rely on Python for Excel file generation, eliminating the need for Golang expertise.

Installation

Install via pip (Recommended)

You can easily install the package via pip

pip install pyfastexcel

Install manually

If you prefer to build the package manually, follow these steps:

1. Clone the repository:

   git clone https://github.com/Zncl2222/pyfastexcel.git
   

2. Go to the project root directory:

   cd pyfastexcel
   

3. Install the required golang packages:

   go mod download
   

4. Build the Golang shared library using the Makefile:

   make
   

5. Install the required python packages:

   pip install -r requirements.txt
   

   or

   pipenv install
   

6. Import the project and start using it!

Requirements

Operating System	Version
Linux	Ubuntu 18.04 or higher
macOS	macOS 13 (x86-64)
Windows	Windows 10 or higher

Python Versions

• Python 3.8 or higher

For earlier versions of Python or other operating systems, compatibility is not guaranteed.

Usage

The index assignment is now avaliable in Workbook and the StreamWriter. Here is the example usage:

from pyfastexcel import Workbook
from pyfastexcel.utils import set_custom_style

# CustomStyle will be re-implement in future to make it no-longer
# depend on openpyxl_style writer and openpyxl
from pyfastexcel import CustomStyle


if __name__ == '__main__':
    # Workbook
    wb = Workbook()

    # Set and register CustomStyle
    bold_style = CustomStyle(font_size=15, font_bold=True)
    set_custom_style('bold_style', bold_style)

    ws = wb['Sheet1']
    # Write value with default style
    ws['A1'] = 'A1 value'
    # Write value with custom style
    ws['B1'] = ('B1 value', 'bold_style')

    # Write value in slice with default style
    ws['A2': 'C2'] = [1, 2, 3]
    # Write value in slice with custom style
    ws['A3': 'C3'] = [(1, 'bold_style'), (2, 'bold_style'), (3, 'bold_style')]

    # Write value by row with default style (python index 0 is the index 1 in excel)
    ws[3] = [9, 8, 'go']
    # Write value by row with custom style
    ws[4] = [(9, 'bold_style'), (8, 'bold_style'), ('go', 'bold_style')]

    # Send request to golang lib and create excel
    wb.read_lib_and_create_excel()

    # File path to save
    file_path = 'pyexample_workbook.xlsx'
    wb.save(file_path)

For row-by-row Excel writing, consider using StreamWriter, a subclass of Workbook. This class is optimized for streaming large datasets. Learn more in the StreamWriter documentation.

Explore additional examples in the FullExamples.

Documentation

The documentation is hosted on Read the Docs.

• Development Version

• Latest Stable Version

Benchmark

The following result displays the performance comparison between pyfastexcel and openpyxl for writing 50000 rows with 30 columns (Total 1500000 cells). To see more benchmark results, please see the benchmark.

How it Works

The core functionality revolves around encoding Excel cell data and styles, or any other Excel properties, into a JSON string within Python. This JSON payload is then passed through ctypes to a Golang shared library. In Golang, the JSON is parsed, and using the streaming writer of excelize to wrtie excel in high performance.

Current Limitations & Future Plans

Problem 1: Dependence on Other Excel Package

Limitations:

This project currently depends on the CustomStyle object of the openpyxl_style_writer package, which is built for openpyxl to write styles in write-only mode more efficiently without duplicating code.

Future Plans:

This project plans to create its own Style object, making it no longer dependent on the mentioned package.