================================================================================
pyexcel-xlsxr - 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://raw.githubusercontent.com/pyexcel/pyexcel-mobans/master/images/awesome-badge.svg
:target: https://awesome-python.com/#specific-formats-processing
.. image:: https://codecov.io/gh/pyexcel/pyexcel-xlsxr/branch/master/graph/badge.svg
:target: https://codecov.io/gh/pyexcel/pyexcel-xlsxr
.. image:: https://badge.fury.io/py/pyexcel-xlsxr.svg
:target: https://pypi.org/project/pyexcel-xlsxr
.. 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-xlsxr** is a specialized xlsx reader using lxml. It does partial reading, meaning
it wont load all content into memory.
lxml installation
=================
This library depends on lxml. Because its availablity, the use of this library is restricted.
for PyPy, lxml == 3.4.4 are tested to work well. But lxml above 3.4.4 is difficult to get installed.
for Python 3.7, please use lxml==4.1.1.
Otherwise, this library works OK with lxml 3.4.4 or above.
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-xlsxr via pip:
.. code-block:: bash
$ pip install pyexcel-xlsxr
or clone it and install it:
.. code-block:: bash
$ git clone https://github.com/pyexcel/pyexcel-xlsxr.git
$ cd pyexcel-xlsxr
$ python setup.py install
Usage
================================================================================
As a standalone library
--------------------------------------------------------------------------------
Read from an xlsx file
********************************************************************************
Here's the sample code:
.. code-block:: python
>>> from pyexcel_xlsxr 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"]]}
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 |
+-------+-------+-------+
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 |
+-------+-------+-------+
License
================================================================================
New BSD License
Developer guide
==================
Development steps for code changes
#. git clone https://github.com/pyexcel/pyexcel-xlsxr.git
#. cd pyexcel-xlsxr
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.
Change log
================================================================================
0.6.1 - 11.11.2024
--------------------------------------------------------------------------------
**Updated**
#. #9: Potential fix for incorrect reading of data with empty cells when used
with pyexcel
0.6.0 - 10.10.2020
--------------------------------------------------------------------------------
**Updated**
#. New style xlsx plugins, promoted by pyexcel-io v0.6.2.
0.5.3 - 23.06.2020
--------------------------------------------------------------------------------
**Fixed**
#. `#5 <https://github.com/pyexcel/pyexcel-xlsxr/issues/5>`_: AttributeError
when a cell text is None
#. `#2 <https://github.com/pyexcel/pyexcel-xlsxr/issues/2>`_: unit test failed
in OpenSuSE
0.5.2 - 15.09.2018
--------------------------------------------------------------------------------
**Updated**
#. Fix python 3 compactibility
0.5.1 - 14.07.2018
--------------------------------------------------------------------------------
**Updated**
#. `#1 <https://github.com/pyexcel/pyexcel-xlsxr/issues/1>`_: fix xml parsing
problem when the microsoft spreadsheetml 2009 ac name space 'x14ac' made lxml
an idiot
0.5.0 - 24.11.2017
--------------------------------------------------------------------------------
**Added**
#. Initial release. In order align it with pyexcel 0.5.0 release, its version
start from 0.5.0
Raw data
{
"_id": null,
"home_page": "https://github.com/pyexcel/pyexcel-xlsxr",
"name": "pyexcel-xlsxr",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "python",
"author": "C.W.",
"author_email": "info@pyexcel.org",
"download_url": "https://files.pythonhosted.org/packages/54/48/4638bd3455c37954860b034eb7d8254dfc257d1a0825ce69c9e6261e7128/pyexcel_xlsxr-0.6.1.tar.gz",
"platform": null,
"description": "================================================================================\npyexcel-xlsxr - 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://raw.githubusercontent.com/pyexcel/pyexcel-mobans/master/images/awesome-badge.svg\n :target: https://awesome-python.com/#specific-formats-processing\n\n.. image:: https://codecov.io/gh/pyexcel/pyexcel-xlsxr/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/pyexcel/pyexcel-xlsxr\n\n.. image:: https://badge.fury.io/py/pyexcel-xlsxr.svg\n :target: https://pypi.org/project/pyexcel-xlsxr\n\n\n\n\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-xlsxr** is a specialized xlsx reader using lxml. It does partial reading, meaning\nit wont load all content into memory.\n\n\nlxml installation\n=================\n\nThis library depends on lxml. Because its availablity, the use of this library is restricted.\n\nfor PyPy, lxml == 3.4.4 are tested to work well. But lxml above 3.4.4 is difficult to get installed.\n\nfor Python 3.7, please use lxml==4.1.1.\n\nOtherwise, this library works OK with lxml 3.4.4 or above.\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\nNor to read password protected xls, xlsx and ods files.\n\nInstallation\n================================================================================\n\n\nYou can install pyexcel-xlsxr via pip:\n\n.. code-block:: bash\n\n $ pip install pyexcel-xlsxr\n\n\nor clone it and install it:\n\n.. code-block:: bash\n\n $ git clone https://github.com/pyexcel/pyexcel-xlsxr.git\n $ cd pyexcel-xlsxr\n $ python setup.py install\n\nUsage\n================================================================================\n\nAs a standalone library\n--------------------------------------------------------------------------------\n\nRead from an xlsx file\n********************************************************************************\n\nHere's the sample code:\n\n.. code-block:: python\n\n >>> from pyexcel_xlsxr 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\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\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\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-xlsxr.git\n#. cd pyexcel-xlsxr\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\n\n\nChange log\n================================================================================\n\n0.6.1 - 11.11.2024\n--------------------------------------------------------------------------------\n\n**Updated**\n\n#. #9: Potential fix for incorrect reading of data with empty cells when used\n with pyexcel \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.3 - 23.06.2020\n--------------------------------------------------------------------------------\n\n**Fixed**\n\n#. `#5 <https://github.com/pyexcel/pyexcel-xlsxr/issues/5>`_: AttributeError\n when a cell text is None\n#. `#2 <https://github.com/pyexcel/pyexcel-xlsxr/issues/2>`_: unit test failed\n in OpenSuSE\n\n0.5.2 - 15.09.2018\n--------------------------------------------------------------------------------\n\n**Updated**\n\n#. Fix python 3 compactibility\n\n0.5.1 - 14.07.2018\n--------------------------------------------------------------------------------\n\n**Updated**\n\n#. `#1 <https://github.com/pyexcel/pyexcel-xlsxr/issues/1>`_: fix xml parsing\n problem when the microsoft spreadsheetml 2009 ac name space 'x14ac' made lxml\n an idiot\n\n0.5.0 - 24.11.2017\n--------------------------------------------------------------------------------\n\n**Added**\n\n#. Initial release. In order align it with pyexcel 0.5.0 release, its version\n start from 0.5.0\n\n",
"bugtrack_url": null,
"license": "New BSD",
"summary": "Read xlsx file using partial xml",
"version": "0.6.1",
"project_urls": {
"Download": "https://github.com/pyexcel/pyexcel-xlsxr/archive/0.6.1.tar.gz",
"Homepage": "https://github.com/pyexcel/pyexcel-xlsxr"
},
"split_keywords": [
"python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e6654b2f7ca1e57bb7e4f478f275cc1de5d0fb0e0d616a1710ae73d7badbb0ec",
"md5": "ca327780cfcb7c16a46db57cf543cacb",
"sha256": "985675f16836a96ec75853030af249136dcb4fd25827706c823762da9b583742"
},
"downloads": -1,
"filename": "pyexcel_xlsxr-0.6.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "ca327780cfcb7c16a46db57cf543cacb",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.6",
"size": 10584,
"upload_time": "2024-11-11T08:59:49",
"upload_time_iso_8601": "2024-11-11T08:59:49.165722Z",
"url": "https://files.pythonhosted.org/packages/e6/65/4b2f7ca1e57bb7e4f478f275cc1de5d0fb0e0d616a1710ae73d7badbb0ec/pyexcel_xlsxr-0.6.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "54484638bd3455c37954860b034eb7d8254dfc257d1a0825ce69c9e6261e7128",
"md5": "ac554240b212d87966cece1e6556f30f",
"sha256": "d5f674fa8458228b9d37d38f61ecf3c5f48ee9def3bfc058e495fb242259f81d"
},
"downloads": -1,
"filename": "pyexcel_xlsxr-0.6.1.tar.gz",
"has_sig": false,
"md5_digest": "ac554240b212d87966cece1e6556f30f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 19427,
"upload_time": "2024-11-11T08:59:51",
"upload_time_iso_8601": "2024-11-11T08:59:51.013853Z",
"url": "https://files.pythonhosted.org/packages/54/48/4638bd3455c37954860b034eb7d8254dfc257d1a0825ce69c9e6261e7128/pyexcel_xlsxr-0.6.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-11 08:59:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pyexcel",
"github_project": "pyexcel-xlsxr",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "pyexcel-xlsxr"
}
JSON
