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.
Fonts, colors and charts are not supported.
You can install pyexcel-xlsxw via pip:
$ pip install pyexcel-xlsxwor clone it and install it:
$ git clone https://github.com/pyexcel/pyexcel-xlsxw.git $ cd pyexcel-xlsxw $ python setup.py installIf 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. 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.
.. testcode:: :hide: >>> import os >>> import sys >>> if sys.version_info[0] < 3: ... from StringIO import StringIO ... else: ... from io import BytesIO as StringIO >>> PY2 = sys.version_info[0] == 2 >>> if PY2 and sys.version_info[1] < 7: ... from ordereddict import OrderedDict ... else: ... from collections import OrderedDict
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"]]}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 downloadingHere'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]]}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 | +-------+-------+-------+Here is the sample code:
>>> sheet.save_as("another_file.xlsx")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 downloadingNew BSD License
Development steps for code changes
- git clone https://github.com/pyexcel/pyexcel-xlsxw.git
- 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.
Note
As to rnd_requirements.txt, usually, it is created when a dependent library is not released. Once the dependecy is installed (will be released), the future version of the dependency in the requirements.txt will be valid.
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
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
Many information that are shared across pyexcel projects, such as: this developer guide, license info, etc. are stored in pyexcel-commons project.
.moban.d stores the specific meta data for the library.
- 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
.. testcode:: :hide: >>> import os >>> os.unlink("your_file.xlsx") >>> os.unlink("another_file.xlsx")