Skip to main content
https://raw.githubusercontent.com/pyexcel/pyexcel.github.io/master/images/patreon.png https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg https://travis-ci.org/pyexcel/pyexcel-libxlsxw.svg?branch=master https://codecov.io/gh/pyexcel/pyexcel-libxlsxw/branch/master/graph/badge.svg https://badge.fury.io/py/pyexcel-libxlsxw.svg https://pepy.tech/badge/pyexcel-libxlsxw/month https://img.shields.io/gitter/room/gitterHQ/gitter.svg https://img.shields.io/static/v1?label=continuous%20templating&message=%E6%A8%A1%E7%89%88%E6%9B%B4%E6%96%B0&color=blue&style=flat-square https://img.shields.io/static/v1?label=coding%20style&message=black&color=black&style=flat-square https://readthedocs.org/projects/pyexcel-libxlsxw/badge/?version=latest

pyexcel-libxlsxw is a tiny wrapper library to write data in xlsx and xlsm format using libxlsxwriter. You are likely to use it with pyexcel.

Support the project

If your company has embedded pyexcel and its components into a revenue generating product, please support me on github, patreon or bounty source to maintain the project and develop it further.

If you are an individual, you are welcome to support me too and for however long you feel like. As my backer, you will receive early access to pyexcel related contents.

And your issues will get prioritized if you would like to become my patreon as pyexcel pro user.

With your financial support, I will be able to invest a little bit more time in coding, documentation and writing interesting posts.

Known constraints

Fonts, colors and charts are not supported.

Installation

You can install pyexcel-libxlsxw via pip:

$ pip install pyexcel-libxlsxw

or clone it and install it:

$ git clone https://github.com/pyexcel/pyexcel-libxlsxw.git
$ cd pyexcel-libxlsxw
$ python setup.py install

Usage

As a standalone library

Write to an xlsx file

Here’s the sample code to write a dictionary to an xlsx file:

>>> from pyexcel_libxlsxw import save_data
>>> data = OrderedDict() # from collections import OrderedDict
>>> data.update({"Sheet 1": [[1, 2, 3], [4, 5, 6]]})
>>> data.update({"Sheet 2": [["row 1", "row 2", "row 3"]]})
>>> save_data("your_file.xlsx", data)

Here’s the sample code to help you read the data back. You will need to install pyexcel-xls or pyexcel-xlsx.

>>> from pyexcel_io import get_data
>>> data = get_data("your_file.xlsx")
>>> import json
>>> print(json.dumps(data))
{"Sheet 1": [[1, 2, 3], [4, 5, 6]], "Sheet 2": [["row 1", "row 2", "row 3"]]}

Write an xlsx to memory

Here’s the sample code to write a dictionary to an xlsx file:

>>> from pyexcel_libxlsxw import save_data
>>> data = OrderedDict()
>>> data.update({"Sheet 1": [[1, 2, 3], [4, 5, 6]]})
>>> data.update({"Sheet 2": [[7, 8, 9], [10, 11, 12]]})
>>> io = StringIO()
>>> save_data(io, data)
>>> # do something with the io
>>> # In reality, you might give it to your http response
>>> # object for downloading

Here’s the sample code to help you read the data back. You will need to install pyexcel-xls or pyexcel-xlsx.

>>> # This is just an illustration
>>> # In reality, you might deal with xlsx file upload
>>> # where you will read from requests.FILES['YOUR_XLSX_FILE']
>>> data = get_data(io, 'xlsx')
>>> print(json.dumps(data))
{"Sheet 1": [[1, 2, 3], [4, 5, 6]], "Sheet 2": [[7, 8, 9], [10, 11, 12]]}

As a pyexcel plugin

No longer, explicit import is needed since pyexcel version 0.2.2. Instead, this library is auto-loaded. So if you want to read data in xlsx format, installing it is enough.

Let’s assume we have data as the following.

>>> import pyexcel as pe
>>> sheet = pe.get_book(file_name="your_file.xlsx")
>>> sheet
Sheet 1:
+---+---+---+
| 1 | 2 | 3 |
+---+---+---+
| 4 | 5 | 6 |
+---+---+---+
Sheet 2:
+-------+-------+-------+
| row 1 | row 2 | row 3 |
+-------+-------+-------+

Writing to an xlsx file

Here is the sample code:

>>> sheet.save_as("another_file.xlsx")

License

New BSD License

Developer guide

Development steps for code changes

  1. git clone https://github.com/pyexcel/pyexcel-libxlsxw.git

  2. cd pyexcel-libxlsxw

Upgrade your setup tools and pip. They are needed for development and testing only:

  1. pip install –upgrade setuptools pip

Then install relevant development requirements:

  1. pip install -r rnd_requirements.txt # if such a file exists

  2. pip install -r requirements.txt

  3. pip install -r tests/requirements.txt

Once you have finished your changes, please provide test case(s), relevant documentation and update CHANGELOG.rst.

How to test your contribution

Although nose and doctest are both used in code testing, it is adviable that unit tests are put in tests. doctest is incorporated only to make sure the code examples in documentation remain valid across different development releases.

On Linux/Unix systems, please launch your tests like this:

$ make

On Windows systems, please issue this command:

> test.bat

Before you commit

Please run:

$ make format

so as to beautify your code otherwise travis-ci may fail your unit test.

Change log

0.6.0 - 15.10.2020

Updated

  1. Variated from pyexcel-xlsxw, this library uses native libxlsxw.

Metadata

Release files for pyexcel-libxlsxw 0.6.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pyexcel-libxlsxw 0.6.0
File Size Uploaded
pyexcel-libxlsxw-0.6.0.tar.gz 46.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for pyexcel-libxlsxw 0.6.0
File Interpreter ABI Platform
pyexcel_libxlsxw-0.6.0-py3-none-any.whl Python 3 none any Details

Total release size: 52.7 kB

Release files / pyexcel-libxlsxw-0.6.0.tar.gz

Download URL pyexcel-libxlsxw-0.6.0.tar.gz
Size 46.0 kB
Tags Source
SHA-256 checksum
How to use checksums
6447773a0cee632d9d36165141ead6281e289e5fd4d13087b31ab7937119609a
BLAKE2b-256 checksum
How to use checksums
7aafab61b8b40fb59b60266fdd76f220ff6716256517ea343d7fbcf783ad4406
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.9.0

Release files / pyexcel_libxlsxw-0.6.0-py3-none-any.whl

Download URL pyexcel_libxlsxw-0.6.0-py3-none-any.whl
Size 6.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0170be5aefcecfec3a8a0e167509e0ab6aacb908d329bcd18ae7974cff1d1c13
BLAKE2b-256 checksum
How to use checksums
4c1531ac235021cbe695bf04ce0273c3162757f27439a44b6e4f7fe35033d728
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.9.0

Release history Release notifications | RSS feed

This release

0.6.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page