A wrapper library to write data in xlsx and xlsm format
Project description
pyexcel-xlsxw is a tiny wrapper library to write data in xlsx and xlsm fromat using xlsxwriter. You are likely to use it with pyexcel.
Known constraints
Fonts, colors and charts are not supported.
Installation
You can install it via pip:
$ pip install pyexcel-xlsxw
or clone it and install it:
$ git clone https://github.com/pyexcel/pyexcel-xlsxw.git
$ cd pyexcel-xlsxw
$ python setup.py install
Support the project
If your company has embedded pyexcel and its components into a revenue generating product, please support me on patreon to maintain the project and develop it further.
If you are an individual, you are welcome to support me too on patreon and for however long you feel like to. As a patreon, you will receive early access to pyexcel related contents.
With your financial support, I will be able to invest a little bit more time in coding, documentation and writing interesting posts.
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_xlsxw 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_xlsxw 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")
Writing to a StringIO instance
You need to pass a StringIO instance to Writer:
>>> data = [
... [1, 2, 3],
... [4, 5, 6]
... ]
>>> io = StringIO()
>>> sheet = pe.Sheet(data)
>>> io = sheet.save_to_memory("xlsx", io)
>>> # then do something with io
>>> # In reality, you might give it to your http response
>>> # object for downloading
License
New BSD License
Developer guide
Development steps for code changes
cd pyexcel-xlsxw
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
How to update test environment and update documentation
Additional steps are required:
pip install moban
git clone https://github.com/moremoban/setupmobans.git # generic setup
git clone https://github.com/pyexcel/pyexcel-commons.git commons
make your changes in .moban.d directory, then issue command moban
What is pyexcel-commons
Many information that are shared across pyexcel projects, such as: this developer guide, license info, etc. are stored in pyexcel-commons project.
What is .moban.d
.moban.d stores the specific meta data for the library.
Acceptance criteria
Has Test cases written
Has all code lines tested
Passes all Travis CI builds
Has fair amount of documentation if your change is complex
Please update CHANGELOG.rst
Please add yourself to CONTRIBUTORS.rst
Agree on NEW BSD License for your contribution
Change log
0.4.0 - 19.06.2017
Updated
pyexcel-io plugin interface now updated to use lml.
0.3.2 - 03.03.2017
Remove the false claim that this library writes xlsm
0.3.1 - 24.02.2017
#1, Feature request: support Workbook options in XLSXWriter.open()
0.3.0 - 22.12.2016
Support pyexcel-io v0.3.0
0.0.1 - 26.08.2016
initial release to see if xlsxwriter would write xlsx significantly faster than openpyxl
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_xlsxw-0.4.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 97a9261e034ce12f57f1937ec97acb757771389f91cc02e7569d3f6f326a7a05 |
|
MD5 | 3b7f79634bf760b9e2bf2ebde8f749d2 |
|
BLAKE2b-256 | f9c7336041e2462e8ccaf3e620e95577eb71b18c53cf456aa094c788d948bc06 |