Read xlsx file using partial xml
Project description
pyexcel-xlsxr is a specialized xlsx reader using lxml. It does partial reading, meaning it wont load all content into memory.
Known constraints
Fonts, colors and charts are not supported.
Installation
You can install pyexcel-xlsxr via pip:
$ pip install pyexcel-xlsxr
or clone it and install it:
$ git clone https://github.com/pyexcel/pyexcel-xlsxr.git
$ cd pyexcel-xlsxr
$ python setup.py install
Support the project
If your company has embedded pyexcel and its components into a revenue generating product, please support me on patreon to maintain the project and develop it further.
If you are an individual, you are welcome to support me too on patreon and for however long you feel like. As a patreon, you will receive early access to pyexcel related contents.
With your financial support, I will be able to invest a little bit more time in coding, documentation and writing interesting posts.
Usage
As a standalone library
Read from an xlsx file
Here’s the sample code:
>>> 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:
>>> # 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:
>>> 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:
>>> 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:
>>> 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:
>>> 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:
>>> 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:
>>> # 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
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.rst.
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
How to update test environment and update documentation
Additional steps are required:
pip install moban
git clone https://github.com/moremoban/setupmobans.git # generic setup
git clone https://github.com/pyexcel/pyexcel-commons.git commons
make your changes in .moban.d directory, then issue command moban
What is pyexcel-commons
Many information that are shared across pyexcel projects, such as: this developer guide, license info, etc. are stored in pyexcel-commons project.
What is .moban.d
.moban.d stores the specific meta data for the library.
Acceptance criteria
Has Test cases written
Has all code lines tested
Passes all Travis CI builds
Has fair amount of documentation if your change is complex
Please update CHANGELOG.rst
Please add yourself to CONTRIBUTORS.rst
Agree on NEW BSD License for your contribution
Change log
0.5.0 - 24.11.2017
Initial release
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pyexcel_xlsxr-0.5.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 611fe42c601cbb7a4c4ebd97432437d36facf59ac6270a17143ddf256a6c8c1e |
|
MD5 | 23df80f9d31a69e1acf53540e7386ced |
|
BLAKE2b-256 | f808c3e6e95492da45034cfd83a75528d3b1cac810ecdcde896c703e516a7bab |