================================================================================
pyexcel-xls - Let you focus on data, instead of xls format
================================================================================
.. image:: https://raw.githubusercontent.com/pyexcel/pyexcel.github.io/master/images/patreon.png
:target: https://www.patreon.com/chfw
.. image:: https://raw.githubusercontent.com/pyexcel/pyexcel-mobans/master/images/awesome-badge.svg
:target: https://awesome-python.com/#specific-formats-processing
.. image:: https://github.com/pyexcel/pyexcel-xls/workflows/run_tests/badge.svg
:target: http://github.com/pyexcel/pyexcel-xls/actions
.. image:: https://codecov.io/gh/pyexcel/pyexcel-xls/branch/master/graph/badge.svg
:target: https://codecov.io/gh/pyexcel/pyexcel-xls
.. image:: https://badge.fury.io/py/pyexcel-xls.svg
:target: https://pypi.org/project/pyexcel-xls
.. image:: https://anaconda.org/conda-forge/pyexcel-xls/badges/version.svg
:target: https://anaconda.org/conda-forge/pyexcel-xls
.. image:: https://pepy.tech/badge/pyexcel-xls/month
:target: https://pepy.tech/project/pyexcel-xls
.. image:: https://anaconda.org/conda-forge/pyexcel-xls/badges/downloads.svg
:target: https://anaconda.org/conda-forge/pyexcel-xls
.. 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-xls** is a tiny wrapper library to read, manipulate and
write data in xls format and it can read xlsx and xlsm fromat.
You are likely to use it with `pyexcel <https://github.com/pyexcel/pyexcel>`_.
Oct 2021 - Update:
===================
1. v0.6.3 removed the pin on xlrd < 2. If you have xlrd >= 2, this
library will NOT read 'xlsx' format and you need to install pyexcel-xlsx. Othwise,
this library can use xlrd < 2 to read xlsx format for you. So 'xlsx' support
in this library will vary depending on the installed version of xlrd.
2. v0.6.3 can write datetime.timedelta. but when the value is read out,
you will get datetime.datetime. so you as the developer decides what to do with it.
Past news
===========
`detect_merged_cells` allows you to spread the same value among
all merged cells. But be aware that this may slow down its reading
performance.
`skip_hidden_row_and_column` allows you to skip hidden rows
and columns and is defaulted to **True**. It may slow down its reading
performance. And it is only valid for 'xls' files. For 'xlsx' files,
please use pyexcel-xlsx.
Warning
================================================================================
**xls file cannot contain more than 65,000 rows**. You are risking the reputation
of yourself/your company/
`your country <https://www.bbc.co.uk/news/technology-54423988>`_ if you keep
using xls and are not aware of its row limit.
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.
Nor to read password protected xls, xlsx and ods files.
Installation
================================================================================
You can install pyexcel-xls via pip:
.. code-block:: bash
$ pip install pyexcel-xls
or clone it and install it:
.. code-block:: bash
$ git clone https://github.com/pyexcel/pyexcel-xls.git
$ cd pyexcel-xls
$ python setup.py install
Usage
================================================================================
As a standalone library
--------------------------------------------------------------------------------
Write to an xls file
********************************************************************************
Here's the sample code to write a dictionary to an xls file:
.. code-block:: python
>>> from pyexcel_xls 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.xls", data)
Read from an xls file
********************************************************************************
Here's the sample code:
.. code-block:: python
>>> from pyexcel_xls import get_data
>>> data = get_data("your_file.xls")
>>> import json
>>> print(json.dumps(data))
{"Sheet 1": [[1, 2, 3], [4, 5, 6]], "Sheet 2": [["row 1", "row 2", "row 3"]]}
Write an xls to memory
********************************************************************************
Here's the sample code to write a dictionary to an xls file:
.. code-block:: python
>>> from pyexcel_xls 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 xls from memory
********************************************************************************
Continue from previous example:
.. code-block:: python
>>> # This is just an illustration
>>> # In reality, you might deal with xls file upload
>>> # where you will read from requests.FILES['YOUR_XLS_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 xls 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.xls", sheetx)
And let's pretend to read partial data:
.. code-block:: python
>>> partial_data = get_data("huge_file.xls", 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.xls", 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.xls",
... 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 xls format,
installing it is enough.
Reading from an xls file
********************************************************************************
Here is the sample code:
.. code-block:: python
>>> import pyexcel as pe
>>> sheet = pe.get_book(file_name="your_file.xls")
>>> sheet
Sheet 1:
+---+---+---+
| 1 | 2 | 3 |
+---+---+---+
| 4 | 5 | 6 |
+---+---+---+
Sheet 2:
+-------+-------+-------+
| row 1 | row 2 | row 3 |
+-------+-------+-------+
Writing to an xls file
********************************************************************************
Here is the sample code:
.. code-block:: python
>>> sheet.save_as("another_file.xls")
Reading from a IO instance
********************************************************************************
You got to wrap the binary content with stream to get xls working:
.. code-block:: python
>>> # This is just an illustration
>>> # In reality, you might deal with xls file upload
>>> # where you will read from requests.FILES['YOUR_XLS_FILE']
>>> xlsfile = "another_file.xls"
>>> with open(xlsfile, "rb") as f:
... content = f.read()
... r = pe.get_book(file_type="xls", 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("xls", 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-xls.git
#. cd pyexcel-xls
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.yml
.. 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, please issue this command::
> test.bat
Before you commit
------------------------------
Please run::
$ make format
so as to beautify your code otherwise your build may fail your unit test.
Known Issues
=============
* If a zero was typed in a DATE formatted field in xls, you will get "01/01/1900".
* If a zero was typed in a TIME formatted field in xls, you will get "00:00:00".
3 contributors
================================================================================
In alphabetical order:
* `John Vandenberg <https://github.com/jayvdb>`_
* `Peter Carnesciali <https://github.com/pcarn>`_
* `vinraspa <https://github.com/vinraspa>`_
Change log
================================================================================
0.7.0 - 07.10.2021
--------------------------------------------------------------------------------
**Removed**
#. `#46 <https://github.com/pyexcel/pyexcel-xls/issues/46>`_: remove the hard
pin on xlrd version < 2.0
**Added**
#. `#47 <https://github.com/pyexcel/pyexcel-xls/issues/47>`_: limit support to
persist datetime.timedelta. see more details in doc
0.6.2 - 12.12.2020
--------------------------------------------------------------------------------
**Updated**
#. lock down xlrd version less than version 2.0, because 2.0+ does not support
xlsx read
0.6.1 - 21.10.2020
--------------------------------------------------------------------------------
**Updated**
#. Restrict this library to get installed on python 3.6+, because pyexcel-io
0.6.0+ supports only python 3.6+.
0.6.0 - 8.10.2020
--------------------------------------------------------------------------------
**Updated**
#. New style xlsx plugins, promoted by pyexcel-io v0.6.2.
0.5.9 - 29.08.2020
--------------------------------------------------------------------------------
**Added**
#. `#35 <https://github.com/pyexcel/pyexcel-xls/issues/35>`_, include tests
0.5.8 - 22.08.2018
--------------------------------------------------------------------------------
**Added**
#. `pyexcel#151 <https://github.com/pyexcel/pyexcel/issues/151>`_, read cell
error as #N/A.
0.5.7 - 15.03.2018
--------------------------------------------------------------------------------
**Added**
#. `pyexcel#54 <https://github.com/pyexcel/pyexcel/issues/54>`_, Book.datemode
attribute of that workbook should be passed always.
0.5.6 - 15.03.2018
--------------------------------------------------------------------------------
**Added**
#. `pyexcel#120 <https://github.com/pyexcel/pyexcel/issues/120>`_, xlwt cannot
save a book without any sheet. So, let's raise an exception in this case in
order to warn the developers.
0.5.5 - 8.11.2017
--------------------------------------------------------------------------------
**Added**
#. `#25 <https://github.com/pyexcel/pyexcel-xls/issues/25>`_, detect merged cell
in .xls
0.5.4 - 2.11.2017
--------------------------------------------------------------------------------
**Added**
#. `#24 <https://github.com/pyexcel/pyexcel-xls/issues/24>`_, xlsx format cannot
use skip_hidden_row_and_column. please use pyexcel-xlsx instead.
0.5.3 - 2.11.2017
--------------------------------------------------------------------------------
**Added**
#. `#21 <https://github.com/pyexcel/pyexcel-xls/issues/21>`_, 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**
#. `#20 <https://github.com/pyexcel/pyexcel-xls/issues/20>`_, is handled in
pyexcel-io
#. 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.
0.4.1 - 25.08.2017
--------------------------------------------------------------------------------
**Updated**
#. `#20 <https://github.com/pyexcel/pyexcel-xls/issues/20>`_, handle unseekable
stream given by http response.
0.4.0 - 19.06.2017
--------------------------------------------------------------------------------
**Updated**
#. `pyexcel-xlsx#15 <https://github.com/pyexcel/pyexcel-xlsx/issues/15>`_, close
file handle
#. pyexcel-io plugin interface now updated to use `lml
<https://github.com/chfw/lml>`_.
0.3.3 - 30/05/2017
--------------------------------------------------------------------------------
**Updated**
#. `#18 <https://github.com/pyexcel/pyexcel-xls/issues/18>`_, pass on
encoding_override and others to xlrd.
0.3.2 - 18.05.2017
--------------------------------------------------------------------------------
**Updated**
#. `#16 <https://github.com/pyexcel/pyexcel-xls/issues/16>`_, allow mmap to be
passed as file content
0.3.1 - 16.01.2017
--------------------------------------------------------------------------------
**Updated**
#. `#14 <https://github.com/pyexcel/pyexcel-xls/issues/14>`_, Python 3.6 -
cannot use LOCALE flag with a str pattern
#. fix its dependency on pyexcel-io 0.3.0
0.3.0 - 22.12.2016
--------------------------------------------------------------------------------
**Updated**
#. `#13 <https://github.com/pyexcel/pyexcel-xls/issues/13>`_, alert on empyty
file content
#. Support pyexcel-io v0.3.0
0.2.3 - 20.09.2016
--------------------------------------------------------------------------------
**Updated**
#. `#10 <https://github.com/pyexcel/pyexcel-xls/issues/10>`_, To support
generator as member of the incoming two dimensional data
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 - 13.07.2016
--------------------------------------------------------------------------------
**Added**
#. `#9 <https://github.com/pyexcel/pyexcel-xls/issues/9>`_, `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**
#. By default, `float` will be converted to `int` where fits. `auto_detect_int`,
a flag to switch off the autoatic conversion from `float` to `int`.
#. 'library=pyexcel-xls' was added so as 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
#. xlwt is now used for python 2 implementation while xlwt-future is used for
python 3
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.
Raw data
{
"_id": null,
"home_page": "https://github.com/pyexcel/pyexcel-xls",
"name": "pyexcel-xls",
"maintainer": "",
"docs_url": "https://pythonhosted.org/pyexcel-xls/",
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "python,xls,xlsx,xlsm",
"author": "C.W.",
"author_email": "info@pyexcel.org",
"download_url": "https://files.pythonhosted.org/packages/71/20/a8945b1acc2076b78c3a2319389364f088a75474e07178ac8d9250dd0a48/pyexcel-xls-0.7.0.tar.gz",
"platform": "",
"description": "================================================================================\npyexcel-xls - Let you focus on data, instead of xls 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://raw.githubusercontent.com/pyexcel/pyexcel-mobans/master/images/awesome-badge.svg\n :target: https://awesome-python.com/#specific-formats-processing\n\n.. image:: https://github.com/pyexcel/pyexcel-xls/workflows/run_tests/badge.svg\n :target: http://github.com/pyexcel/pyexcel-xls/actions\n\n.. image:: https://codecov.io/gh/pyexcel/pyexcel-xls/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/pyexcel/pyexcel-xls\n\n.. image:: https://badge.fury.io/py/pyexcel-xls.svg\n :target: https://pypi.org/project/pyexcel-xls\n\n.. image:: https://anaconda.org/conda-forge/pyexcel-xls/badges/version.svg\n :target: https://anaconda.org/conda-forge/pyexcel-xls\n\n.. image:: https://pepy.tech/badge/pyexcel-xls/month\n :target: https://pepy.tech/project/pyexcel-xls\n\n.. image:: https://anaconda.org/conda-forge/pyexcel-xls/badges/downloads.svg\n :target: https://anaconda.org/conda-forge/pyexcel-xls\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-xls** is a tiny wrapper library to read, manipulate and\nwrite data in xls format and it can read xlsx and xlsm fromat.\nYou are likely to use it with `pyexcel <https://github.com/pyexcel/pyexcel>`_.\n\nOct 2021 - Update:\n===================\n\n1. v0.6.3 removed the pin on xlrd < 2. If you have xlrd >= 2, this\nlibrary will NOT read 'xlsx' format and you need to install pyexcel-xlsx. Othwise,\nthis library can use xlrd < 2 to read xlsx format for you. So 'xlsx' support\nin this library will vary depending on the installed version of xlrd.\n\n2. v0.6.3 can write datetime.timedelta. but when the value is read out,\nyou will get datetime.datetime. so you as the developer decides what to do with it.\n\nPast news\n===========\n\n`detect_merged_cells` allows you to spread the same value among\nall merged cells. But be aware that this may slow down its reading\nperformance.\n\n`skip_hidden_row_and_column` allows you to skip hidden rows\nand columns and is defaulted to **True**. It may slow down its reading\nperformance. And it is only valid for 'xls' files. For 'xlsx' files,\nplease use pyexcel-xlsx.\n\nWarning\n================================================================================\n\n**xls file cannot contain more than 65,000 rows**. You are risking the reputation\nof yourself/your company/\n`your country <https://www.bbc.co.uk/news/technology-54423988>`_ if you keep\nusing xls and are not aware of its row limit.\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\nNor to read password protected xls, xlsx and ods files.\n\nInstallation\n================================================================================\n\n\nYou can install pyexcel-xls via pip:\n\n.. code-block:: bash\n\n $ pip install pyexcel-xls\n\n\nor clone it and install it:\n\n.. code-block:: bash\n\n $ git clone https://github.com/pyexcel/pyexcel-xls.git\n $ cd pyexcel-xls\n $ python setup.py install\n\nUsage\n================================================================================\n\nAs a standalone library\n--------------------------------------------------------------------------------\n\nWrite to an xls file\n********************************************************************************\n\n\n\nHere's the sample code to write a dictionary to an xls file:\n\n.. code-block:: python\n\n >>> from pyexcel_xls 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.xls\", data)\n\n\nRead from an xls file\n********************************************************************************\n\nHere's the sample code:\n\n.. code-block:: python\n\n >>> from pyexcel_xls import get_data\n >>> data = get_data(\"your_file.xls\")\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 xls to memory\n********************************************************************************\n\nHere's the sample code to write a dictionary to an xls file:\n\n.. code-block:: python\n\n >>> from pyexcel_xls 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 xls 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 xls file upload\n >>> # where you will read from requests.FILES['YOUR_XLS_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 xls 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.xls\", sheetx)\n\nAnd let's pretend to read partial data:\n\n.. code-block:: python\n\n >>> partial_data = get_data(\"huge_file.xls\", 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.xls\", 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.xls\",\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 xls format,\ninstalling it is enough.\n\n\nReading from an xls 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.xls\")\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 xls file\n********************************************************************************\n\nHere is the sample code:\n\n.. code-block:: python\n\n >>> sheet.save_as(\"another_file.xls\")\n\n\nReading from a IO instance\n********************************************************************************\n\nYou got to wrap the binary content with stream to get xls working:\n\n.. code-block:: python\n\n >>> # This is just an illustration\n >>> # In reality, you might deal with xls file upload\n >>> # where you will read from requests.FILES['YOUR_XLS_FILE']\n >>> xlsfile = \"another_file.xls\"\n >>> with open(xlsfile, \"rb\") as f:\n ... content = f.read()\n ... r = pe.get_book(file_type=\"xls\", 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(\"xls\", 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-xls.git\n#. cd pyexcel-xls\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.yml\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, 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 your build may fail your unit test.\n\n\nKnown Issues\n=============\n\n* If a zero was typed in a DATE formatted field in xls, you will get \"01/01/1900\".\n* If a zero was typed in a TIME formatted field in xls, you will get \"00:00:00\".\n\n\n\n\n3 contributors\n================================================================================\n\nIn alphabetical order:\n\n* `John Vandenberg <https://github.com/jayvdb>`_\n* `Peter Carnesciali <https://github.com/pcarn>`_\n* `vinraspa <https://github.com/vinraspa>`_\n\nChange log\n================================================================================\n\n0.7.0 - 07.10.2021\n--------------------------------------------------------------------------------\n\n**Removed**\n\n#. `#46 <https://github.com/pyexcel/pyexcel-xls/issues/46>`_: remove the hard\n pin on xlrd version < 2.0\n\n**Added**\n\n#. `#47 <https://github.com/pyexcel/pyexcel-xls/issues/47>`_: limit support to\n persist datetime.timedelta. see more details in doc\n\n0.6.2 - 12.12.2020\n--------------------------------------------------------------------------------\n\n**Updated**\n\n#. lock down xlrd version less than version 2.0, because 2.0+ does not support\n xlsx read\n\n0.6.1 - 21.10.2020\n--------------------------------------------------------------------------------\n\n**Updated**\n\n#. Restrict this library to get installed on python 3.6+, because pyexcel-io\n 0.6.0+ supports only python 3.6+.\n\n0.6.0 - 8.10.2020\n--------------------------------------------------------------------------------\n\n**Updated**\n\n#. New style xlsx plugins, promoted by pyexcel-io v0.6.2.\n\n0.5.9 - 29.08.2020\n--------------------------------------------------------------------------------\n\n**Added**\n\n#. `#35 <https://github.com/pyexcel/pyexcel-xls/issues/35>`_, include tests\n\n0.5.8 - 22.08.2018\n--------------------------------------------------------------------------------\n\n**Added**\n\n#. `pyexcel#151 <https://github.com/pyexcel/pyexcel/issues/151>`_, read cell\n error as #N/A.\n\n0.5.7 - 15.03.2018\n--------------------------------------------------------------------------------\n\n**Added**\n\n#. `pyexcel#54 <https://github.com/pyexcel/pyexcel/issues/54>`_, Book.datemode\n attribute of that workbook should be passed always.\n\n0.5.6 - 15.03.2018\n--------------------------------------------------------------------------------\n\n**Added**\n\n#. `pyexcel#120 <https://github.com/pyexcel/pyexcel/issues/120>`_, xlwt cannot\n save a book without any sheet. So, let's raise an exception in this case in\n order to warn the developers.\n\n0.5.5 - 8.11.2017\n--------------------------------------------------------------------------------\n\n**Added**\n\n#. `#25 <https://github.com/pyexcel/pyexcel-xls/issues/25>`_, detect merged cell\n in .xls\n\n0.5.4 - 2.11.2017\n--------------------------------------------------------------------------------\n\n**Added**\n\n#. `#24 <https://github.com/pyexcel/pyexcel-xls/issues/24>`_, xlsx format cannot\n use skip_hidden_row_and_column. please use pyexcel-xlsx instead.\n\n0.5.3 - 2.11.2017\n--------------------------------------------------------------------------------\n\n**Added**\n\n#. `#21 <https://github.com/pyexcel/pyexcel-xls/issues/21>`_, 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#. `#20 <https://github.com/pyexcel/pyexcel-xls/issues/20>`_, is handled in\n pyexcel-io\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\n0.4.1 - 25.08.2017\n--------------------------------------------------------------------------------\n\n**Updated**\n\n#. `#20 <https://github.com/pyexcel/pyexcel-xls/issues/20>`_, handle unseekable\n stream given by http response.\n\n0.4.0 - 19.06.2017\n--------------------------------------------------------------------------------\n\n**Updated**\n\n#. `pyexcel-xlsx#15 <https://github.com/pyexcel/pyexcel-xlsx/issues/15>`_, close\n file handle\n#. pyexcel-io plugin interface now updated to use `lml\n <https://github.com/chfw/lml>`_.\n\n0.3.3 - 30/05/2017\n--------------------------------------------------------------------------------\n\n**Updated**\n\n#. `#18 <https://github.com/pyexcel/pyexcel-xls/issues/18>`_, pass on\n encoding_override and others to xlrd.\n\n0.3.2 - 18.05.2017\n--------------------------------------------------------------------------------\n\n**Updated**\n\n#. `#16 <https://github.com/pyexcel/pyexcel-xls/issues/16>`_, allow mmap to be\n passed as file content\n\n0.3.1 - 16.01.2017\n--------------------------------------------------------------------------------\n\n**Updated**\n\n#. `#14 <https://github.com/pyexcel/pyexcel-xls/issues/14>`_, Python 3.6 -\n cannot use LOCALE flag with a str pattern\n#. fix its dependency on pyexcel-io 0.3.0\n\n0.3.0 - 22.12.2016\n--------------------------------------------------------------------------------\n\n**Updated**\n\n#. `#13 <https://github.com/pyexcel/pyexcel-xls/issues/13>`_, alert on empyty\n file content\n#. Support pyexcel-io v0.3.0\n\n0.2.3 - 20.09.2016\n--------------------------------------------------------------------------------\n\n**Updated**\n\n#. `#10 <https://github.com/pyexcel/pyexcel-xls/issues/10>`_, To support\n generator as member of the incoming two dimensional data\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 - 13.07.2016\n--------------------------------------------------------------------------------\n\n**Added**\n\n#. `#9 <https://github.com/pyexcel/pyexcel-xls/issues/9>`_, `skip_hidden_sheets`\n is added. By default, hidden sheets are skipped when reading all sheets.\n Reading sheet by name or by index are not affected.\n\n0.2.0 - 01.06.2016\n--------------------------------------------------------------------------------\n\n**Added**\n\n#. By default, `float` will be converted to `int` where fits. `auto_detect_int`,\n a flag to switch off the autoatic conversion from `float` to `int`.\n#. 'library=pyexcel-xls' was added so as to inform pyexcel to use it instead of\n other libraries, in the situation where there are more than one plugin for a\n file type, e.g. xlsm\n\n**Updated**\n\n#. support the auto-import feature of pyexcel-io 0.2.0\n#. xlwt is now used for python 2 implementation while xlwt-future is used for\n python 3\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\n\n",
"bugtrack_url": null,
"license": "New BSD",
"summary": "A wrapper library to read, manipulate and write data in xls format. Itreads xlsx and xlsm format",
"version": "0.7.0",
"split_keywords": [
"python",
"xls",
"xlsx",
"xlsm"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "3c7bf8ea485a03acc80c37f4e7ee75d7",
"sha256": "31c6652ddc8758428ed59c7f2c34a1173abb8f3c7ebdba6fce051ff6f78b8135"
},
"downloads": -1,
"filename": "pyexcel_xls-0.7.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "3c7bf8ea485a03acc80c37f4e7ee75d7",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.6",
"size": 11689,
"upload_time": "2021-10-07T19:01:12",
"upload_time_iso_8601": "2021-10-07T19:01:12.284191Z",
"url": "https://files.pythonhosted.org/packages/f1/a5/8150710c764803793d908b5aa818a22f085eb672444a75b16ca040fc003b/pyexcel_xls-0.7.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "26dcc128da4981ba2990e237d8949fff",
"sha256": "5ec606ef8667aafbb0c3fbd8242a7c23bf175ee7c10b08f70799b84fb2db84cb"
},
"downloads": -1,
"filename": "pyexcel-xls-0.7.0.tar.gz",
"has_sig": false,
"md5_digest": "26dcc128da4981ba2990e237d8949fff",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 53833,
"upload_time": "2021-10-07T19:01:14",
"upload_time_iso_8601": "2021-10-07T19:01:14.716892Z",
"url": "https://files.pythonhosted.org/packages/71/20/a8945b1acc2076b78c3a2319389364f088a75474e07178ac8d9250dd0a48/pyexcel-xls-0.7.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2021-10-07 19:01:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "pyexcel",
"github_project": "pyexcel-xls",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "pyexcel-io",
"specs": [
[
">=",
"0.6.2"
]
]
},
{
"name": "xlrd",
"specs": []
},
{
"name": "xlwt",
"specs": []
}
],
"lcname": "pyexcel-xls"
}
JSON
