pyfastexcel 0.0.5__tar.gz → 0.0.7__tar.gz

pyfastexcel-0.0.7/PKG-INFO

@@ -0,0 +1,183 @@
+Metadata-Version: 2.1
+Name: pyfastexcel
+Version: 0.0.7
+Summary: High performace excel file generation library.
+Home-page: https://github.com/Zncl2222/pyfastexcel
+Author: Zncl2222
+Author-email: 3002shinning@gmail.com
+License: MIT
+Classifier: Development Status :: 4 - Beta
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Go
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: msgspec
+Requires-Dist: openpyxl-style-writer>=1.1.3
+
+# pyfastexcel
+
+![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/Zncl2222/pyfastexcel/go.yml?logo=go)
+[![Go Report Card](https://goreportcard.com/badge/github.com/Zncl2222/pyfastexcel)](https://goreportcard.com/report/github.com/Zncl2222/pyfastexcel)
+![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/Zncl2222/pyfastexcel/pre-commit.yml?logo=pre-commit&label=pre-commit)
+![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/Zncl2222/pyfastexcel/codeql.yml?logo=github&label=CodeQL)
+[![Codacy Badge](https://app.codacy.com/project/badge/Grade/03f42030775045b791586dee20288905)](https://app.codacy.com/gh/Zncl2222/pyfastexcel/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
+[![codecov](https://codecov.io/gh/Zncl2222/pyfastexcel/graph/badge.svg?token=6I03AWUUWL)](https://codecov.io/gh/Zncl2222/pyfastexcel)
+[![Documentation Status](https://readthedocs.org/projects/pyfastexcel/badge/?version=stable)](https://pyfastexcel.readthedocs.io/en/stable/?badge=stable)
+
+This package enables high-performance Excel writing by integrating with the
+streaming API from the golang package
+[excelize](https://github.com/qax-os/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
+
+```bash
+pip install pyfastexcel
+```
+
+### Install manually
+
+If you prefer to build the package manually, follow these steps:
+
+1. Clone the repository:
+
+    ```bash
+    git clone https://github.com/Zncl2222/pyfastexcel.git
+    ```
+
+2. Go to the project root directory:
+
+    ```bash
+    cd pyfastexcel
+    ```
+
+3. Install the required golang packages:
+
+    ```bash
+    go mod download
+    ```
+
+4. Build the Golang shared library using the Makefile:
+
+    ```bash
+    make
+    ```
+
+5. Install the required python packages:
+
+    ```bash
+    pip install -r requirements.txt
+    ```
+
+    or
+
+    ```bash
+    pipenv install
+    ```
+
+6. Import the project and start using it!
+
+## Usage
+
+The index assignment is now avaliable in `Workbook` and the `FastWriter`.
+Here is the example usage:
+
+```python
+from pyfastexcel import Workbook
+from pyfastexcel.utils import set_custom_style
+
+# CustomStyle will be integrate to the pyfatexcel in next version
+# Beside, CustomStyle will be re-implement in future to make it no-longer
+# depend on openpyxl_style writer and openpyxl
+from openpyxl_style_writer 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)
+
+```
+
+You can also using the `FastWriter` or `NormalWriter` which was the
+subclass of `Workbook` to write excel row by row, see the more in documentations [quickstart](https://pyfastexcel.readthedocs.io/en/stable/quickstart/).
+
+## Documentation
+
+The documentation is hosted on Read the Docs.
+
+- [Development Version](https://pyfastexcel.readthedocs.io/en/latest/)
+
+- [Latest Stable Version](https://pyfastexcel.readthedocs.io/en/stable/)
+
+## 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](https://github.com/qax-os/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](https://github.com/Zncl2222/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.

pyfastexcel-0.0.7/README.md

@@ -0,0 +1,159 @@
+# pyfastexcel
+
+![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/Zncl2222/pyfastexcel/go.yml?logo=go)
+[![Go Report Card](https://goreportcard.com/badge/github.com/Zncl2222/pyfastexcel)](https://goreportcard.com/report/github.com/Zncl2222/pyfastexcel)
+![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/Zncl2222/pyfastexcel/pre-commit.yml?logo=pre-commit&label=pre-commit)
+![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/Zncl2222/pyfastexcel/codeql.yml?logo=github&label=CodeQL)
+[![Codacy Badge](https://app.codacy.com/project/badge/Grade/03f42030775045b791586dee20288905)](https://app.codacy.com/gh/Zncl2222/pyfastexcel/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
+[![codecov](https://codecov.io/gh/Zncl2222/pyfastexcel/graph/badge.svg?token=6I03AWUUWL)](https://codecov.io/gh/Zncl2222/pyfastexcel)
+[![Documentation Status](https://readthedocs.org/projects/pyfastexcel/badge/?version=stable)](https://pyfastexcel.readthedocs.io/en/stable/?badge=stable)
+
+This package enables high-performance Excel writing by integrating with the
+streaming API from the golang package
+[excelize](https://github.com/qax-os/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
+
+```bash
+pip install pyfastexcel
+```
+
+### Install manually
+
+If you prefer to build the package manually, follow these steps:
+
+1. Clone the repository:
+
+    ```bash
+    git clone https://github.com/Zncl2222/pyfastexcel.git
+    ```
+
+2. Go to the project root directory:
+
+    ```bash
+    cd pyfastexcel
+    ```
+
+3. Install the required golang packages:
+
+    ```bash
+    go mod download
+    ```
+
+4. Build the Golang shared library using the Makefile:
+
+    ```bash
+    make
+    ```
+
+5. Install the required python packages:
+
+    ```bash
+    pip install -r requirements.txt
+    ```
+
+    or
+
+    ```bash
+    pipenv install
+    ```
+
+6. Import the project and start using it!
+
+## Usage
+
+The index assignment is now avaliable in `Workbook` and the `FastWriter`.
+Here is the example usage:
+
+```python
+from pyfastexcel import Workbook
+from pyfastexcel.utils import set_custom_style
+
+# CustomStyle will be integrate to the pyfatexcel in next version
+# Beside, CustomStyle will be re-implement in future to make it no-longer
+# depend on openpyxl_style writer and openpyxl
+from openpyxl_style_writer 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)
+
+```
+
+You can also using the `FastWriter` or `NormalWriter` which was the
+subclass of `Workbook` to write excel row by row, see the more in documentations [quickstart](https://pyfastexcel.readthedocs.io/en/stable/quickstart/).
+
+## Documentation
+
+The documentation is hosted on Read the Docs.
+
+- [Development Version](https://pyfastexcel.readthedocs.io/en/latest/)
+
+- [Latest Stable Version](https://pyfastexcel.readthedocs.io/en/stable/)
+
+## 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](https://github.com/qax-os/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](https://github.com/Zncl2222/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.

pyfastexcel-0.0.7/pyfastexcel/__init__.py

@@ -0,0 +1,13 @@
+from openpyxl_style_writer import CustomStyle, DefaultStyle
+
+from pyfastexcel.writer import FastWriter, NormalWriter, Workbook
+
+__all__ = [
+    'Workbook',
+    'FastWriter',
+    'NormalWriter',
+    # Temporary link the CustomStyle from openpyxl_style_writer for
+    # convinent usage.
+    'CustomStyle',
+    'DefaultStyle',
+]