================================================================================
pyexcel-xlsx - 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-xlsx.svg?branch=master
:target: http://travis-ci.org/pyexcel/pyexcel-xlsx
.. image:: https://codecov.io/gh/pyexcel/pyexcel-xlsx/branch/master/graph/badge.svg
:target: https://codecov.io/gh/pyexcel/pyexcel-xlsx
.. image:: https://badge.fury.io/py/pyexcel-xlsx.svg
:target: https://pypi.org/project/pyexcel-xlsx
.. image:: https://anaconda.org/conda-forge/pyexcel-xlsx/badges/version.svg
:target: https://anaconda.org/conda-forge/pyexcel-xlsx
.. image:: https://pepy.tech/badge/pyexcel-xlsx/month
:target: https://pepy.tech/project/pyexcel-xlsx/month
.. image:: https://anaconda.org/conda-forge/pyexcel-xlsx/badges/downloads.svg
:target: https://anaconda.org/conda-forge/pyexcel-xlsx
.. 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
**pyexcel-xlsx** is a tiny wrapper library to read, manipulate and write data in xlsx and xlsm format using `read_only` mode reader, `write_only` mode writer from openpyxl. You are likely to use it with `pyexcel <https://github.com/pyexcel/pyexcel>`__.
Please note:
1. `auto_detect_int` flag will not take effect because openpyxl detect integer in python 3 by default.
2. `skip_hidden_row_and_column` will get a penalty where `read_only` mode cannot be used.
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-xlsx via pip:
.. code-block:: bash
$ pip install pyexcel-xlsx
or clone it and install it:
.. code-block:: bash
$ git clone https://github.com/pyexcel/pyexcel-xlsx.git
$ cd pyexcel-xlsx
$ 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_xlsx 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)
Read from an xlsx file
********************************************************************************
Here's the sample code:
.. code-block:: python
>>> from pyexcel_xlsx 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_xlsx 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
Read from an xlsx from memory
********************************************************************************
Continue from previous example:
.. 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)
>>> print(json.dumps(data))
{"Sheet 1": [[1, 2, 3], [4, 5, 6]], "Sheet 2": [[7, 8, 9], [10, 11, 12]]}
Pagination feature
********************************************************************************
Let's assume the following file is a huge xlsx file:
.. code-block:: python
>>> huge_data = [
... [1, 21, 31],
... [2, 22, 32],
... [3, 23, 33],
... [4, 24, 34],
... [5, 25, 35],
... [6, 26, 36]
... ]
>>> sheetx = {
... "huge": huge_data
... }
>>> save_data("huge_file.xlsx", sheetx)
And let's pretend to read partial data:
.. code-block:: python
>>> partial_data = get_data("huge_file.xlsx", start_row=2, row_limit=3)
>>> print(json.dumps(partial_data))
{"huge": [[3, 23, 33], [4, 24, 34], [5, 25, 35]]}
And you could as well do the same for columns:
.. code-block:: python
>>> partial_data = get_data("huge_file.xlsx", start_column=1, column_limit=2)
>>> print(json.dumps(partial_data))
{"huge": [[21, 31], [22, 32], [23, 33], [24, 34], [25, 35], [26, 36]]}
Obvious, you could do both at the same time:
.. code-block:: python
>>> partial_data = get_data("huge_file.xlsx",
... start_row=2, row_limit=3,
... start_column=1, column_limit=2)
>>> print(json.dumps(partial_data))
{"huge": [[23, 33], [24, 34], [25, 35]]}
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.
Reading from an xlsx file
********************************************************************************
Here is the sample code:
.. 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")
Reading from a IO instance
********************************************************************************
You got to wrap the binary content with stream to get xlsx working:
.. 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']
>>> xlsxfile = "another_file.xlsx"
>>> with open(xlsxfile, "rb") as f:
... content = f.read()
... r = pe.get_book(file_type="xlsx", file_content=content)
... print(r)
...
Sheet 1:
+---+---+---+
| 1 | 2 | 3 |
+---+---+---+
| 4 | 5 | 6 |
+---+---+---+
Sheet 2:
+-------+-------+-------+
| row 1 | row 2 | row 3 |
+-------+-------+-------+
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-xlsx.git
#. cd pyexcel-xlsx
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.0 - 10.10.2020
--------------------------------------------------------------------------------
**Updated**
#. New style xlsx plugins, promoted by pyexcel-io v0.6.2.
0.5.8 - 28.12.2019
--------------------------------------------------------------------------------
**Updated**
#. `#34 <https://github.com/pyexcel/pyexcel-xlsx/issues/34>`_: pin
openpyxl>=2.6.1
0.5.7 - 15.02.2019
--------------------------------------------------------------------------------
**Added**
#. `pyexcel-io#66 <https://github.com/pyexcel/pyexcel-io/issues/66>`_ pin
openpyxl < 2.6.0
0.5.6 - 26.03.2018
--------------------------------------------------------------------------------
**Added**
#. `#24 <https://github.com/pyexcel/pyexcel-xlsx/issues/24>`_, remove deprecated
warning from merged_cell_ranges and get_sheet_by_name
0.5.5 - 18.12.2017
--------------------------------------------------------------------------------
**Added**
#. `#22 <https://github.com/pyexcel/pyexcel-xlsx/issues/22>`_, to detect merged
cell in xlsx - fast tracked patreon request.
0.5.4 - 2.11.2017
--------------------------------------------------------------------------------
**Updated**
#. Align the behavior of skip_hidden_row_and_column. Default it to True.
0.5.3 - 2.11.2017
--------------------------------------------------------------------------------
**Added**
#. `#20 <https://github.com/pyexcel/pyexcel-xlsx/issues/20>`_, skip hidden rows
and columns under 'skip_hidden_row_and_column' flag.
0.5.2 - 23.10.2017
--------------------------------------------------------------------------------
**updated**
#. pyexcel `pyexcel#105 <https://github.com/pyexcel/pyexcel/issues/105>`_,
remove gease from setup_requires, introduced by 0.5.1.
#. remove python2.6 test support
#. update its dependecy on pyexcel-io to 0.5.3
0.5.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.5.0 - 30.08.2017
--------------------------------------------------------------------------------
**Updated**
#. put dependency on pyexcel-io 0.5.0, which uses cStringIO instead of StringIO.
Hence, there will be performance boost in handling files in memory.
**Removed**
#. `#18 <https://github.com/pyexcel/pyexcel-xlsx/issues/18>`_, is handled in
pyexcel-io
0.4.2 - 25.08.2017
--------------------------------------------------------------------------------
**Updated**
#. `#18 <https://github.com/pyexcel/pyexcel-xlsx/issues/18>`_, handle unseekable
stream given by http response
0.4.1 - 16.07.2017
--------------------------------------------------------------------------------
**Removed**
#. Removed useless code
0.4.0 - 19.06.2017
--------------------------------------------------------------------------------
**Updated**
#. `#14 <https://github.com/pyexcel/pyexcel-xlsx/issues/14>`_, close file handle
#. pyexcel-io plugin interface now updated to use `lml
<https://github.com/chfw/lml>`_.
0.3.0 - 22.12.2016
--------------------------------------------------------------------------------
**Updated**
#. Code refactoring with pyexcel-io v 0.3.0
#. `#13 <https://github.com/pyexcel/pyexcel-xlsx/issues/13>`_, turn read_only
flag on openpyxl.
0.2.3 - 05.11.2016
--------------------------------------------------------------------------------
**Updated**
#. `#12 <https://github.com/pyexcel/pyexcel-xlsx/issues/12>`_, remove
UserWarning: Using a coordinate with ws.cell is deprecated. Use
ws[coordinate]
0.2.2 - 31.08.2016
--------------------------------------------------------------------------------
**Added**
#. support pagination. two pairs: start_row, row_limit and start_column,
column_limit help you deal with large files.
0.2.1 - 12.07.2016
--------------------------------------------------------------------------------
**Added**
#. `#8 <https://github.com/pyexcel/pyexcel-xlsx/issues/8>`__,
`skip_hidden_sheets` is added. By default, hidden sheets are skipped when
reading all sheets. Reading sheet by name or by index are not affected.
0.2.0 - 01.06.2016
--------------------------------------------------------------------------------
**Added**
#. 'library=pyexcel-xlsx' was added to inform pyexcel to use it instead of other
libraries, in the situation where there are more than one plugin for a file
type, e.g. xlsm
**Updated**
#. support the auto-import feature of pyexcel-io 0.2.0
0.1.0 - 17.01.2016
--------------------------------------------------------------------------------
**Added**
#. Passing "streaming=True" to get_data, you will get the two dimensional array
as a generator
#. Passing "data=your_generator" to save_data is acceptable too.
**Updated**
#. compatibility with pyexcel-io 0.1.0
Raw data
{
"_id": null,
"home_page": "https://github.com/pyexcel/pyexcel-xlsx",
"name": "pyexcel-xlsx",
"maintainer": "",
"docs_url": "https://pythonhosted.org/pyexcel-xlsx/",
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "python,xlsx",
"author": "chfw",
"author_email": "info@pyexcel.org",
"download_url": "https://files.pythonhosted.org/packages/a2/37/04c3f339a775e9bfa852e50e781b8ba04a31a1ea5a3826c4b46f9874adad/pyexcel-xlsx-0.6.0.tar.gz",
"platform": "",
"description": "================================================================================\npyexcel-xlsx - Let you focus on data, instead of xlsx format\n================================================================================\n\n.. image:: https://raw.githubusercontent.com/pyexcel/pyexcel.github.io/master/images/patreon.png\n :target: https://www.patreon.com/chfw\n\n.. image:: https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg\n :target: https://awesome-python.com/#specific-formats-processing\n\n.. image:: https://travis-ci.org/pyexcel/pyexcel-xlsx.svg?branch=master\n :target: http://travis-ci.org/pyexcel/pyexcel-xlsx\n\n.. image:: https://codecov.io/gh/pyexcel/pyexcel-xlsx/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/pyexcel/pyexcel-xlsx\n\n.. image:: https://badge.fury.io/py/pyexcel-xlsx.svg\n :target: https://pypi.org/project/pyexcel-xlsx\n\n.. image:: https://anaconda.org/conda-forge/pyexcel-xlsx/badges/version.svg\n :target: https://anaconda.org/conda-forge/pyexcel-xlsx\n\n.. image:: https://pepy.tech/badge/pyexcel-xlsx/month\n :target: https://pepy.tech/project/pyexcel-xlsx/month\n\n.. image:: https://anaconda.org/conda-forge/pyexcel-xlsx/badges/downloads.svg\n :target: https://anaconda.org/conda-forge/pyexcel-xlsx\n\n.. image:: https://img.shields.io/gitter/room/gitterHQ/gitter.svg\n :target: https://gitter.im/pyexcel/Lobby\n\n.. 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\n :target: https://moban.readthedocs.io/en/latest/#at-scale-continous-templating-for-open-source-projects\n\n.. image:: https://img.shields.io/static/v1?label=coding%20style&message=black&color=black&style=flat-square\n :target: https://github.com/psf/black\n\n**pyexcel-xlsx** is a tiny wrapper library to read, manipulate and write data in xlsx and xlsm format using `read_only` mode reader, `write_only` mode writer from openpyxl. You are likely to use it with `pyexcel <https://github.com/pyexcel/pyexcel>`__.\n\nPlease note:\n\n1. `auto_detect_int` flag will not take effect because openpyxl detect integer in python 3 by default.\n2. `skip_hidden_row_and_column` will get a penalty where `read_only` mode cannot be used.\n\n\n\nSupport the project\n================================================================================\n\nIf your company has embedded pyexcel and its components into a revenue generating\nproduct, please support me on github, `patreon <https://www.patreon.com/bePatron?u=5537627>`_\nor `bounty source <https://salt.bountysource.com/teams/chfw-pyexcel>`_ to maintain\nthe project and develop it further.\n\nIf you are an individual, you are welcome to support me too and for however long\nyou feel like. As my backer, you will receive\n`early access to pyexcel related contents <https://www.patreon.com/pyexcel/posts>`_.\n\nAnd your issues will get prioritized if you would like to become my patreon as `pyexcel pro user`.\n\nWith your financial support, I will be able to invest\na little bit more time in coding, documentation and writing interesting posts.\n\n\nKnown constraints\n==================\n\nFonts, colors and charts are not supported.\n\nInstallation\n================================================================================\n\n\nYou can install pyexcel-xlsx via pip:\n\n.. code-block:: bash\n\n $ pip install pyexcel-xlsx\n\n\nor clone it and install it:\n\n.. code-block:: bash\n\n $ git clone https://github.com/pyexcel/pyexcel-xlsx.git\n $ cd pyexcel-xlsx\n $ python setup.py install\n\nUsage\n================================================================================\n\nAs a standalone library\n--------------------------------------------------------------------------------\n\nWrite to an xlsx file\n********************************************************************************\n\n\n\nHere's the sample code to write a dictionary to an xlsx file:\n\n.. code-block:: python\n\n >>> from pyexcel_xlsx import save_data\n >>> data = OrderedDict() # from collections import OrderedDict\n >>> data.update({\"Sheet 1\": [[1, 2, 3], [4, 5, 6]]})\n >>> data.update({\"Sheet 2\": [[\"row 1\", \"row 2\", \"row 3\"]]})\n >>> save_data(\"your_file.xlsx\", data)\n\n\nRead from an xlsx file\n********************************************************************************\n\nHere's the sample code:\n\n.. code-block:: python\n\n >>> from pyexcel_xlsx import get_data\n >>> data = get_data(\"your_file.xlsx\")\n >>> import json\n >>> print(json.dumps(data))\n {\"Sheet 1\": [[1, 2, 3], [4, 5, 6]], \"Sheet 2\": [[\"row 1\", \"row 2\", \"row 3\"]]}\n\n\nWrite an xlsx to memory\n********************************************************************************\n\nHere's the sample code to write a dictionary to an xlsx file:\n\n.. code-block:: python\n\n >>> from pyexcel_xlsx import save_data\n >>> data = OrderedDict()\n >>> data.update({\"Sheet 1\": [[1, 2, 3], [4, 5, 6]]})\n >>> data.update({\"Sheet 2\": [[7, 8, 9], [10, 11, 12]]})\n >>> io = StringIO()\n >>> save_data(io, data)\n >>> # do something with the io\n >>> # In reality, you might give it to your http response\n >>> # object for downloading\n\n\n\n\nRead from an xlsx from memory\n********************************************************************************\n\nContinue from previous example:\n\n.. code-block:: python\n\n >>> # This is just an illustration\n >>> # In reality, you might deal with xlsx file upload\n >>> # where you will read from requests.FILES['YOUR_XLSX_FILE']\n >>> data = get_data(io)\n >>> print(json.dumps(data))\n {\"Sheet 1\": [[1, 2, 3], [4, 5, 6]], \"Sheet 2\": [[7, 8, 9], [10, 11, 12]]}\n\n\nPagination feature\n********************************************************************************\n\n\n\nLet's assume the following file is a huge xlsx file:\n\n.. code-block:: python\n\n >>> huge_data = [\n ... [1, 21, 31],\n ... [2, 22, 32],\n ... [3, 23, 33],\n ... [4, 24, 34],\n ... [5, 25, 35],\n ... [6, 26, 36]\n ... ]\n >>> sheetx = {\n ... \"huge\": huge_data\n ... }\n >>> save_data(\"huge_file.xlsx\", sheetx)\n\nAnd let's pretend to read partial data:\n\n.. code-block:: python\n\n >>> partial_data = get_data(\"huge_file.xlsx\", start_row=2, row_limit=3)\n >>> print(json.dumps(partial_data))\n {\"huge\": [[3, 23, 33], [4, 24, 34], [5, 25, 35]]}\n\nAnd you could as well do the same for columns:\n\n.. code-block:: python\n\n >>> partial_data = get_data(\"huge_file.xlsx\", start_column=1, column_limit=2)\n >>> print(json.dumps(partial_data))\n {\"huge\": [[21, 31], [22, 32], [23, 33], [24, 34], [25, 35], [26, 36]]}\n\nObvious, you could do both at the same time:\n\n.. code-block:: python\n\n >>> partial_data = get_data(\"huge_file.xlsx\",\n ... start_row=2, row_limit=3,\n ... start_column=1, column_limit=2)\n >>> print(json.dumps(partial_data))\n {\"huge\": [[23, 33], [24, 34], [25, 35]]}\n\nAs a pyexcel plugin\n--------------------------------------------------------------------------------\n\nNo longer, explicit import is needed since pyexcel version 0.2.2. Instead,\nthis library is auto-loaded. So if you want to read data in xlsx format,\ninstalling it is enough.\n\n\nReading from an xlsx file\n********************************************************************************\n\nHere is the sample code:\n\n.. code-block:: python\n\n >>> import pyexcel as pe\n >>> sheet = pe.get_book(file_name=\"your_file.xlsx\")\n >>> sheet\n Sheet 1:\n +---+---+---+\n | 1 | 2 | 3 |\n +---+---+---+\n | 4 | 5 | 6 |\n +---+---+---+\n Sheet 2:\n +-------+-------+-------+\n | row 1 | row 2 | row 3 |\n +-------+-------+-------+\n\n\nWriting to an xlsx file\n********************************************************************************\n\nHere is the sample code:\n\n.. code-block:: python\n\n >>> sheet.save_as(\"another_file.xlsx\")\n\n\nReading from a IO instance\n********************************************************************************\n\nYou got to wrap the binary content with stream to get xlsx working:\n\n.. code-block:: python\n\n >>> # This is just an illustration\n >>> # In reality, you might deal with xlsx file upload\n >>> # where you will read from requests.FILES['YOUR_XLSX_FILE']\n >>> xlsxfile = \"another_file.xlsx\"\n >>> with open(xlsxfile, \"rb\") as f:\n ... content = f.read()\n ... r = pe.get_book(file_type=\"xlsx\", file_content=content)\n ... print(r)\n ...\n Sheet 1:\n +---+---+---+\n | 1 | 2 | 3 |\n +---+---+---+\n | 4 | 5 | 6 |\n +---+---+---+\n Sheet 2:\n +-------+-------+-------+\n | row 1 | row 2 | row 3 |\n +-------+-------+-------+\n\n\nWriting to a StringIO instance\n********************************************************************************\n\nYou need to pass a StringIO instance to Writer:\n\n.. code-block:: python\n\n >>> data = [\n ... [1, 2, 3],\n ... [4, 5, 6]\n ... ]\n >>> io = StringIO()\n >>> sheet = pe.Sheet(data)\n >>> io = sheet.save_to_memory(\"xlsx\", io)\n >>> # then do something with io\n >>> # In reality, you might give it to your http response\n >>> # object for downloading\n\n\nLicense\n================================================================================\n\nNew BSD License\n\nDeveloper guide\n==================\n\nDevelopment steps for code changes\n\n#. git clone https://github.com/pyexcel/pyexcel-xlsx.git\n#. cd pyexcel-xlsx\n\nUpgrade your setup tools and pip. They are needed for development and testing only:\n\n#. pip install --upgrade setuptools pip\n\nThen install relevant development requirements:\n\n#. pip install -r rnd_requirements.txt # if such a file exists\n#. pip install -r requirements.txt\n#. pip install -r tests/requirements.txt\n\nOnce you have finished your changes, please provide test case(s), relevant documentation\nand update CHANGELOG.rst.\n\n.. note::\n\n As to rnd_requirements.txt, usually, it is created when a dependent\n library is not released. Once the dependecy is installed\n (will be released), the future\n version of the dependency in the requirements.txt will be valid.\n\n\nHow to test your contribution\n------------------------------\n\nAlthough `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.\n\nOn Linux/Unix systems, please launch your tests like this::\n\n $ make\n\nOn Windows systems, please issue this command::\n\n > test.bat\n\n\nBefore you commit\n------------------------------\n\nPlease run::\n\n $ make format\n\nso as to beautify your code otherwise travis-ci may fail your unit test.\n\n\n\n\nChange log\n================================================================================\n\n0.6.0 - 10.10.2020\n--------------------------------------------------------------------------------\n\n**Updated**\n\n#. New style xlsx plugins, promoted by pyexcel-io v0.6.2.\n\n0.5.8 - 28.12.2019\n--------------------------------------------------------------------------------\n\n**Updated**\n\n#. `#34 <https://github.com/pyexcel/pyexcel-xlsx/issues/34>`_: pin\n openpyxl>=2.6.1\n\n0.5.7 - 15.02.2019\n--------------------------------------------------------------------------------\n\n**Added**\n\n#. `pyexcel-io#66 <https://github.com/pyexcel/pyexcel-io/issues/66>`_ pin\n openpyxl < 2.6.0\n\n0.5.6 - 26.03.2018\n--------------------------------------------------------------------------------\n\n**Added**\n\n#. `#24 <https://github.com/pyexcel/pyexcel-xlsx/issues/24>`_, remove deprecated\n warning from merged_cell_ranges and get_sheet_by_name\n\n0.5.5 - 18.12.2017\n--------------------------------------------------------------------------------\n\n**Added**\n\n#. `#22 <https://github.com/pyexcel/pyexcel-xlsx/issues/22>`_, to detect merged\n cell in xlsx - fast tracked patreon request.\n\n0.5.4 - 2.11.2017\n--------------------------------------------------------------------------------\n\n**Updated**\n\n#. Align the behavior of skip_hidden_row_and_column. Default it to True.\n\n0.5.3 - 2.11.2017\n--------------------------------------------------------------------------------\n\n**Added**\n\n#. `#20 <https://github.com/pyexcel/pyexcel-xlsx/issues/20>`_, skip hidden rows\n and columns under 'skip_hidden_row_and_column' flag.\n\n0.5.2 - 23.10.2017\n--------------------------------------------------------------------------------\n\n**updated**\n\n#. pyexcel `pyexcel#105 <https://github.com/pyexcel/pyexcel/issues/105>`_,\n remove gease from setup_requires, introduced by 0.5.1.\n#. remove python2.6 test support\n#. update its dependecy on pyexcel-io to 0.5.3\n\n0.5.1 - 20.10.2017\n--------------------------------------------------------------------------------\n\n**added**\n\n#. `pyexcel#103 <https://github.com/pyexcel/pyexcel/issues/103>`_, include\n LICENSE file in MANIFEST.in, meaning LICENSE file will appear in the released\n tar ball.\n\n0.5.0 - 30.08.2017\n--------------------------------------------------------------------------------\n\n**Updated**\n\n#. put dependency on pyexcel-io 0.5.0, which uses cStringIO instead of StringIO.\n Hence, there will be performance boost in handling files in memory.\n\n**Removed**\n\n#. `#18 <https://github.com/pyexcel/pyexcel-xlsx/issues/18>`_, is handled in\n pyexcel-io\n\n0.4.2 - 25.08.2017\n--------------------------------------------------------------------------------\n\n**Updated**\n\n#. `#18 <https://github.com/pyexcel/pyexcel-xlsx/issues/18>`_, handle unseekable\n stream given by http response\n\n0.4.1 - 16.07.2017\n--------------------------------------------------------------------------------\n\n**Removed**\n\n#. Removed useless code\n\n0.4.0 - 19.06.2017\n--------------------------------------------------------------------------------\n\n**Updated**\n\n#. `#14 <https://github.com/pyexcel/pyexcel-xlsx/issues/14>`_, close file handle\n#. pyexcel-io plugin interface now updated to use `lml\n <https://github.com/chfw/lml>`_.\n\n0.3.0 - 22.12.2016\n--------------------------------------------------------------------------------\n\n**Updated**\n\n#. Code refactoring with pyexcel-io v 0.3.0\n#. `#13 <https://github.com/pyexcel/pyexcel-xlsx/issues/13>`_, turn read_only\n flag on openpyxl.\n\n0.2.3 - 05.11.2016\n--------------------------------------------------------------------------------\n\n**Updated**\n\n#. `#12 <https://github.com/pyexcel/pyexcel-xlsx/issues/12>`_, remove\n UserWarning: Using a coordinate with ws.cell is deprecated. Use\n ws[coordinate]\n\n0.2.2 - 31.08.2016\n--------------------------------------------------------------------------------\n\n**Added**\n\n#. support pagination. two pairs: start_row, row_limit and start_column,\n column_limit help you deal with large files.\n\n0.2.1 - 12.07.2016\n--------------------------------------------------------------------------------\n\n**Added**\n\n#. `#8 <https://github.com/pyexcel/pyexcel-xlsx/issues/8>`__,\n `skip_hidden_sheets` is added. By default, hidden sheets are skipped when\n reading all sheets. Reading sheet by name or by index are not affected.\n\n0.2.0 - 01.06.2016\n--------------------------------------------------------------------------------\n\n**Added**\n\n#. 'library=pyexcel-xlsx' was added to inform pyexcel to use it instead of other\n libraries, in the situation where there are more than one plugin for a file\n type, e.g. xlsm\n\n**Updated**\n\n#. support the auto-import feature of pyexcel-io 0.2.0\n\n0.1.0 - 17.01.2016\n--------------------------------------------------------------------------------\n\n**Added**\n\n#. Passing \"streaming=True\" to get_data, you will get the two dimensional array\n as a generator\n#. Passing \"data=your_generator\" to save_data is acceptable too.\n\n**Updated**\n\n#. compatibility with pyexcel-io 0.1.0\n\n\n\n",
"bugtrack_url": null,
"license": "New BSD",
"summary": "A wrapper library to read, manipulate and write data in xlsx and xlsmformat",
"version": "0.6.0",
"split_keywords": [
"python",
"xlsx"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "201b265664a23a4b8fc16a211b2b230b",
"sha256": "16530f96a77c97ebcba7941517d2756ac52d3ce2903d81eecd7f300778d5242a"
},
"downloads": -1,
"filename": "pyexcel_xlsx-0.6.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "201b265664a23a4b8fc16a211b2b230b",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.6",
"size": 9634,
"upload_time": "2020-10-10T13:13:32",
"upload_time_iso_8601": "2020-10-10T13:13:32.642135Z",
"url": "https://files.pythonhosted.org/packages/6e/25/80131799ac6ab63c01749bb0d34664ebfd8478e51fbdda0dcef6a3556162/pyexcel_xlsx-0.6.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "2568f61cc1f8af09390c60f811edbd33",
"sha256": "55754f764252461aca6871db203f4bd1370ec877828e305e6be1de5f9aa6a79d"
},
"downloads": -1,
"filename": "pyexcel-xlsx-0.6.0.tar.gz",
"has_sig": false,
"md5_digest": "2568f61cc1f8af09390c60f811edbd33",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 78818,
"upload_time": "2020-10-10T13:13:35",
"upload_time_iso_8601": "2020-10-10T13:13:35.212182Z",
"url": "https://files.pythonhosted.org/packages/a2/37/04c3f339a775e9bfa852e50e781b8ba04a31a1ea5a3826c4b46f9874adad/pyexcel-xlsx-0.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2020-10-10 13:13:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "pyexcel",
"github_project": "pyexcel-xlsx",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "openpyxl",
"specs": [
[
">=",
"2.6.1"
]
]
},
{
"name": "pyexcel-io",
"specs": [
[
">=",
"0.6.2"
]
]
}
],
"lcname": "pyexcel-xlsx"
}
JSON
