A wrapper library of libxlsxwpy to write data in xlsx and xlsm format
Project description
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
cd pyexcel-libxlsxw
Upgrade your setup tools and pip. They are needed for development and testing only:
pip install –upgrade setuptools pip
Then install relevant development requirements:
pip install -r rnd_requirements.txt # if such a file exists
pip install -r requirements.txt
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
Variated from pyexcel-xlsxw, this library uses native libxlsxw.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pyexcel_libxlsxw-0.6.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0170be5aefcecfec3a8a0e167509e0ab6aacb908d329bcd18ae7974cff1d1c13 |
|
MD5 | 0b670f7ec2bff6a5ae08b5f1e4cba782 |
|
BLAKE2b-256 | 4c1531ac235021cbe695bf04ce0273c3162757f27439a44b6e4f7fe35033d728 |