pyexcel-xlsxw 0.6.1
A wrapper library to write data in xlsx and xlsm format
License: New BSD
Requires Python: >=3.6
Keywords: python,xlsx

================================================================================
pyexcel-xlsxw - Let you focus on data, instead of xlsx format
================================================================================

.. image:: https://raw.githubusercontent.com/pyexcel/pyexcel.github.io/master/images/patreon.png
   :target: https://www.patreon.com/chfw

.. image:: https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg
   :target: https://awesome-python.com/#specific-formats-processing

.. image:: https://travis-ci.org/pyexcel/pyexcel-xlsxw.svg?branch=master
   :target: http://travis-ci.org/pyexcel/pyexcel-xlsxw

.. image:: https://codecov.io/gh/pyexcel/pyexcel-xlsxw/branch/master/graph/badge.svg
   :target: https://codecov.io/gh/pyexcel/pyexcel-xlsxw

.. image:: https://badge.fury.io/py/pyexcel-xlsxw.svg
   :target: https://pypi.org/project/pyexcel-xlsxw


.. image:: https://pepy.tech/badge/pyexcel-xlsxw/month
   :target: https://pepy.tech/project/pyexcel-xlsxw/month


.. image:: https://img.shields.io/gitter/room/gitterHQ/gitter.svg
   :target: https://gitter.im/pyexcel/Lobby

.. image:: 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
    :target: https://moban.readthedocs.io/en/latest/#at-scale-continous-templating-for-open-source-projects

.. image:: https://img.shields.io/static/v1?label=coding%20style&message=black&color=black&style=flat-square
    :target: https://github.com/psf/black
.. image:: https://readthedocs.org/projects/pyexcel-xlsxw/badge/?version=latest
   :target: http://pyexcel-xlsxw.readthedocs.org/en/latest/

**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 <https://github.com/pyexcel/pyexcel>`__.

Support the project
================================================================================

If your company has embedded pyexcel and its components into a revenue generating
product, please support me on github, `patreon <https://www.patreon.com/bePatron?u=5537627>`_
or `bounty source <https://salt.bountysource.com/teams/chfw-pyexcel>`_ 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 <https://www.patreon.com/pyexcel/posts>`_.

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-xlsxw via pip:

.. code-block:: bash

    $ pip install pyexcel-xlsxw


or clone it and install it:

.. code-block:: bash

    $ git clone https://github.com/pyexcel/pyexcel-xlsxw.git
    $ cd pyexcel-xlsxw
    $ 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:

.. code-block:: python

    >>> 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.

.. code-block:: python

    >>> 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:

.. code-block:: python

    >>> 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.

.. code-block:: python

    >>> # 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.

.. code-block:: python

    >>> 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:

.. code-block:: python

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


Writing to a StringIO instance
********************************************************************************

You need to pass a StringIO instance to Writer:

.. code-block:: python

    >>> 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

#. 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.


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.1 - 10.10.2020
--------------------------------------------------------------------------------

**Fixed**

#. `#9 <https://github.com/pyexcel/pyexcel-xlsxw/issues/9>`_: pyexcel-xlsxw
   0.6.0 failed to write to a stream

0.6.0 - 8.10.2020
--------------------------------------------------------------------------------

**Updated**

#. New style xlsx plugins, promoted by pyexcel-io v0.6.2.

0.4.2 - 23.10.2017
--------------------------------------------------------------------------------

**updated**

#. pyexcel `pyexcel#105 <https://github.com/pyexcel/pyexcel/issues/105>`_,
   remove gease from setup_requires, introduced by 0.4.1.
#. remove python2.6 test support

0.4.1 - 20.10.2017
--------------------------------------------------------------------------------

**added**

#. `pyexcel#103 <https://github.com/pyexcel/pyexcel/issues/103>`_, include
   LICENSE file in MANIFEST.in, meaning LICENSE file will appear in the released
   tar ball.

0.4.0 - 19.06.2017
--------------------------------------------------------------------------------

**Updated**

#. pyexcel-io plugin interface now updated to use `lml
   <https://github.com/chfw/lml>`_.
#. Remove the false claim that this library writes xlsm
#. `#1 <https://github.com/pyexcel/pyexcel-xlsxw/issues/1>`_, Feature request:
   support Workbook options in XLSXWriter.open()
#. Support pyexcel-io v0.3.0
#. initial release to see if xlsxwriter would write xlsx significantly faster
   than openpyxl

0.3.2 - 03.03.2017
--------------------------------------------------------------------------------

**Updated**

#. pyexcel-io plugin interface now updated to use `lml
   <https://github.com/chfw/lml>`_.
#. Remove the false claim that this library writes xlsm
#. `#1 <https://github.com/pyexcel/pyexcel-xlsxw/issues/1>`_, Feature request:
   support Workbook options in XLSXWriter.open()
#. Support pyexcel-io v0.3.0
#. initial release to see if xlsxwriter would write xlsx significantly faster
   than openpyxl

0.3.1 - 24.02.2017
--------------------------------------------------------------------------------

**Updated**

#. pyexcel-io plugin interface now updated to use `lml
   <https://github.com/chfw/lml>`_.
#. Remove the false claim that this library writes xlsm
#. `#1 <https://github.com/pyexcel/pyexcel-xlsxw/issues/1>`_, Feature request:
   support Workbook options in XLSXWriter.open()
#. Support pyexcel-io v0.3.0
#. initial release to see if xlsxwriter would write xlsx significantly faster
   than openpyxl

0.3.0 - 22.12.2016
--------------------------------------------------------------------------------

**Updated**

#. pyexcel-io plugin interface now updated to use `lml
   <https://github.com/chfw/lml>`_.
#. Remove the false claim that this library writes xlsm
#. `#1 <https://github.com/pyexcel/pyexcel-xlsxw/issues/1>`_, Feature request:
   support Workbook options in XLSXWriter.open()
#. Support pyexcel-io v0.3.0
#. initial release to see if xlsxwriter would write xlsx significantly faster
   than openpyxl

0.0.1 - 26.08.2016
--------------------------------------------------------------------------------

**Updated**

#. pyexcel-io plugin interface now updated to use `lml
   <https://github.com/chfw/lml>`_.
#. Remove the false claim that this library writes xlsm
#. `#1 <https://github.com/pyexcel/pyexcel-xlsxw/issues/1>`_, Feature request:
   support Workbook options in XLSXWriter.open()
#. Support pyexcel-io v0.3.0
#. initial release to see if xlsxwriter would write xlsx significantly faster
   than openpyxl