Package: pyexcel-xlsxw
pyexcel-xlsxwis a tiny wrapper library to write data in xlsx and xlsm fromat using xlsxwriter. You are likely to use it withpyexcel.Support the projectIf your company has embedded pyexcel and its components into a revenue generating
product, please support me on github,patreonorbounty sourceto 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 receiveearly access to pyexcel related contents.And your issues will get prioritized if you would like to become my patreon aspyexcel 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 constraintsFonts, colors and charts are not supported.InstallationYou can install pyexcel-xlsxw via pip:$pipinstallpyexcel-xlsxwor clone it and install it:$gitclonehttps://github.com/pyexcel/pyexcel-xlsxw.git$cdpyexcel-xlsxw$pythonsetup.pyinstallUsageAs a standalone libraryWrite to an xlsx fileHere’s the sample code to write a dictionary to an xlsx file:>>>frompyexcel_xlsxwimportsave_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.>>>frompyexcel_ioimportget_data>>>data=get_data("your_file.xlsx")>>>importjson>>>print(json.dumps(data)){"Sheet 1":[[1,2,3],[4,5,6]],"Sheet 2":[["row 1","row 2","row 3"]]}Write an xlsx to memoryHere’s the sample code to write a dictionary to an xlsx file:>>>frompyexcel_xlsxwimportsave_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]]}As a pyexcel pluginNo 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.>>>importpyexcelaspe>>>sheet=pe.get_book(file_name="your_file.xlsx")>>>sheetSheet1:+---+---+---+|1|2|3|+---+---+---+|4|5|6|+---+---+---+Sheet2:+-------+-------+-------+|row1|row2|row3|+-------+-------+-------+Writing to an xlsx fileHere is the sample code:>>>sheet.save_as("another_file.xlsx")Writing to a StringIO instanceYou 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 downloadingLicenseNew BSD LicenseDeveloper guideDevelopment steps for code changesgit clonehttps://github.com/pyexcel/pyexcel-xlsxw.gitcd pyexcel-xlsxwUpgrade your setup tools and pip. They are needed for development and testing only:pip install –upgrade setuptools pipThen install relevant development requirements:pip install -r rnd_requirements.txt # if such a file existspip install -r requirements.txtpip install -r tests/requirements.txtOnce you have finished your changes, please provide test case(s), relevant documentation
and update CHANGELOG.rst.NoteAs 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.How to test your contributionAlthoughnoseanddoctestare both used in code testing, it is adviable that unit tests are put in tests.doctestis 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:$ makeOn Windows systems, please issue this command:> test.batBefore you commitPlease run:$ make formatso as to beautify your code otherwise travis-ci may fail your unit test.Change log0.6.1 - 10.10.2020Fixed#9: pyexcel-xlsxw
0.6.0 failed to write to a stream0.6.0 - 8.10.2020UpdatedNew style xlsx plugins, promoted by pyexcel-io v0.6.2.0.4.2 - 23.10.2017updatedpyexcelpyexcel#105,
remove gease from setup_requires, introduced by 0.4.1.remove python2.6 test support0.4.1 - 20.10.2017addedpyexcel#103, include
LICENSE file in MANIFEST.in, meaning LICENSE file will appear in the released
tar ball.0.4.0 - 19.06.2017Updatedpyexcel-io plugin interface now updated to uselml.Remove the false claim that this library writes xlsm#1, Feature request:
support Workbook options in XLSXWriter.open()Support pyexcel-io v0.3.0initial release to see if xlsxwriter would write xlsx significantly faster
than openpyxl0.3.2 - 03.03.2017Updatedpyexcel-io plugin interface now updated to uselml.Remove the false claim that this library writes xlsm#1, Feature request:
support Workbook options in XLSXWriter.open()Support pyexcel-io v0.3.0initial release to see if xlsxwriter would write xlsx significantly faster
than openpyxl0.3.1 - 24.02.2017Updatedpyexcel-io plugin interface now updated to uselml.Remove the false claim that this library writes xlsm#1, Feature request:
support Workbook options in XLSXWriter.open()Support pyexcel-io v0.3.0initial release to see if xlsxwriter would write xlsx significantly faster
than openpyxl0.3.0 - 22.12.2016Updatedpyexcel-io plugin interface now updated to uselml.Remove the false claim that this library writes xlsm#1, Feature request:
support Workbook options in XLSXWriter.open()Support pyexcel-io v0.3.0initial release to see if xlsxwriter would write xlsx significantly faster
than openpyxl0.0.1 - 26.08.2016Updatedpyexcel-io plugin interface now updated to uselml.Remove the false claim that this library writes xlsm#1, Feature request:
support Workbook options in XLSXWriter.open()Support pyexcel-io v0.3.0initial release to see if xlsxwriter would write xlsx significantly faster
than openpyxl