================================================================================
pyexcel - Let you focus on data, instead of file formats
================================================================================
.. 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/workflows/run_tests/badge.svg
:target: http://github.com/pyexcel/pyexcel/actions
.. image:: https://codecov.io/gh/pyexcel/pyexcel/branch/master/graph/badge.svg
:target: https://codecov.io/gh/pyexcel/pyexcel
.. image:: https://badge.fury.io/py/pyexcel.svg
:target: https://pypi.org/project/pyexcel
.. image:: https://anaconda.org/conda-forge/pyexcel/badges/version.svg
:target: https://anaconda.org/conda-forge/pyexcel
.. image:: https://pepy.tech/badge/pyexcel/month
:target: https://pepy.tech/project/pyexcel
.. image:: https://anaconda.org/conda-forge/pyexcel/badges/downloads.svg
:target: https://anaconda.org/conda-forge/pyexcel
.. image:: https://img.shields.io/gitter/room/gitterHQ/gitter.svg
:target: https://gitter.im/pyexcel/Lobby
.. image:: https://img.shields.io/static/v1?label=continuous%20templating&message=%E6%A8%A1%E7%89%88%E6%9B%B4%E6%96%B0&color=blue&style=flat-square
:target: https://moban.readthedocs.io/en/latest/#at-scale-continous-templating-for-open-source-projects
.. image:: https://img.shields.io/static/v1?label=coding%20style&message=black&color=black&style=flat-square
:target: https://github.com/psf/black
.. image:: https://readthedocs.org/projects/pyexcel/badge/?version=latest
:target: http://pyexcel.readthedocs.org/en/latest/
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.
Introduction
================================================================================
Feature Highlights
===================
.. table:: A list of supported file formats
============ =======================================================
file format definition
============ =======================================================
csv comma separated values
tsv tab separated values
csvz a zip file that contains one or many csv files
tsvz a zip file that contains one or many tsv files
xls a spreadsheet file format created by
MS-Excel 97-2003
xlsx MS-Excel Extensions to the Office Open XML
SpreadsheetML File Format.
xlsm an MS-Excel Macro-Enabled Workbook file
ods open document spreadsheet
fods flat open document spreadsheet
json java script object notation
html html table of the data structure
simple simple presentation
rst rStructured Text presentation of the data
mediawiki media wiki table
============ =======================================================
.. image:: https://github.com/pyexcel/pyexcel/raw/dev/docs/source/_static/images/architecture.svg
1. One application programming interface(API) to handle multiple data sources:
* physical file
* memory file
* SQLAlchemy table
* Django Model
* Python data structures: dictionary, records and array
2. One API to read and write data in various excel file formats.
3. For large data sets, data streaming are supported. A genenerator can be returned to you. Checkout iget_records, iget_array, isave_as and isave_book_as.
Installation
================================================================================
You can install pyexcel via pip:
.. code-block:: bash
$ pip install pyexcel
or clone it and install it:
.. code-block:: bash
$ git clone https://github.com/pyexcel/pyexcel.git
$ cd pyexcel
$ python setup.py install
One liners
================================================================================
This section shows you how to get data from your excel files and how to
export data to excel files in **one line**
Read from the excel files
--------------------------------------------------------------------------------
Get a list of dictionaries
********************************************************************************
Suppose you want to process `History of Classical Music <https://www.naxos.com/education/brief_history.asp>`_:
History of Classical Music:
=============== ============= ====================================
Name Period Representative Composers
Medieval c.1150-c.1400 Machaut, Landini
Renaissance c.1400-c.1600 Gibbons, Frescobaldi
Baroque c.1600-c.1750 JS Bach, Vivaldi
Classical c.1750-c.1830 Joseph Haydn, Wolfgan Amadeus Mozart
Earley Romantic c.1830-c.1860 Chopin, Mendelssohn, Schumann, Liszt
Late Romantic c.1860-c.1920 Wagner,Verdi
=============== ============= ====================================
Let's get a list of dictionary out from the xls file:
.. code-block:: python
>>> records = p.get_records(file_name="your_file.xls")
And let's check what do we have:
.. code-block:: python
>>> for row in records:
... print(f"{row['Representative Composers']} are from {row['Name']} period ({row['Period']})")
Machaut, Landini are from Medieval period (c.1150-c.1400)
Gibbons, Frescobaldi are from Renaissance period (c.1400-c.1600)
JS Bach, Vivaldi are from Baroque period (c.1600-c.1750)
Joseph Haydn, Wolfgan Amadeus Mozart are from Classical period (c.1750-c.1830)
Chopin, Mendelssohn, Schumann, Liszt are from Earley Romantic period (c.1830-c.1860)
Wagner,Verdi are from Late Romantic period (c.1860-c.1920)
Get two dimensional array
********************************************************************************
Instead, what if you have to use `pyexcel.get_array` to do the same:
.. code-block:: python
>>> for row in p.get_array(file_name="your_file.xls", start_row=1):
... print(f"{row[2]} are from {row[0]} period ({row[1]})")
Machaut, Landini are from Medieval period (c.1150-c.1400)
Gibbons, Frescobaldi are from Renaissance period (c.1400-c.1600)
JS Bach, Vivaldi are from Baroque period (c.1600-c.1750)
Joseph Haydn, Wolfgan Amadeus Mozart are from Classical period (c.1750-c.1830)
Chopin, Mendelssohn, Schumann, Liszt are from Earley Romantic period (c.1830-c.1860)
Wagner,Verdi are from Late Romantic period (c.1860-c.1920)
where `start_row` skips the header row.
Get a dictionary
********************************************************************************
You can get a dictionary too:
Now let's get a dictionary out from the spreadsheet:
.. code-block:: python
>>> my_dict = p.get_dict(file_name="your_file.xls", name_columns_by_row=0)
And check what do we have:
.. code-block:: python
>>> from pyexcel._compact import OrderedDict
>>> isinstance(my_dict, OrderedDict)
True
>>> for key, values in my_dict.items():
... print(key + " : " + ','.join([str(item) for item in values]))
Name : Medieval,Renaissance,Baroque,Classical,Earley Romantic,Late Romantic
Period : c.1150-c.1400,c.1400-c.1600,c.1600-c.1750,c.1750-c.1830,c.1830-c.1860,c.1860-c.1920
Representative Composers : Machaut, Landini,Gibbons, Frescobaldi,JS Bach, Vivaldi,Joseph Haydn, Wolfgan Amadeus Mozart,Chopin, Mendelssohn, Schumann, Liszt,Wagner,Verdi
Please note that my_dict is an OrderedDict.
Get a dictionary of two dimensional array
********************************************************************************
Suppose you have a multiple sheet book as the following:
pyexcel:Sheet 1:
===================== = =
1 2 3
4 5 6
7 8 9
===================== = =
pyexcel:Sheet 2:
===================== = =
X Y Z
1 2 3
4 5 6
===================== = =
pyexcel:Sheet 3:
===================== = =
O P Q
3 2 1
4 3 2
===================== = =
Here is the code to obtain those sheets as a single dictionary:
.. code-block:: python
>>> book_dict = p.get_book_dict(file_name="book.xls")
And check:
.. code-block:: python
>>> isinstance(book_dict, OrderedDict)
True
>>> import json
>>> for key, item in book_dict.items():
... print(json.dumps({key: item}))
{"Sheet 1": [[1, 2, 3], [4, 5, 6], [7, 8, 9]]}
{"Sheet 2": [["X", "Y", "Z"], [1, 2, 3], [4, 5, 6]]}
{"Sheet 3": [["O", "P", "Q"], [3, 2, 1], [4, 3, 2]]}
Write data
---------------------------------------------
Export an array
**********************
Suppose you have the following array:
.. code-block:: python
>>> data = [[1, 2, 3], [4, 5, 6], [7, 8, 9]]
And here is the code to save it as an excel file :
.. code-block:: python
>>> p.save_as(array=data, dest_file_name="example.xls")
Let's verify it:
.. code-block:: python
>>> p.get_sheet(file_name="example.xls")
pyexcel_sheet1:
+---+---+---+
| 1 | 2 | 3 |
+---+---+---+
| 4 | 5 | 6 |
+---+---+---+
| 7 | 8 | 9 |
+---+---+---+
And here is the code to save it as a csv file :
.. code-block:: python
>>> p.save_as(array=data,
... dest_file_name="example.csv",
... dest_delimiter=':')
Let's verify it:
.. code-block:: python
>>> with open("example.csv") as f:
... for line in f.readlines():
... print(line.rstrip())
...
1:2:3
4:5:6
7:8:9
Export a list of dictionaries
**********************************
.. code-block:: python
>>> records = [
... {"year": 1903, "country": "Germany", "speed": "206.7km/h"},
... {"year": 1964, "country": "Japan", "speed": "210km/h"},
... {"year": 2008, "country": "China", "speed": "350km/h"}
... ]
>>> p.save_as(records=records, dest_file_name='high_speed_rail.xls')
Export a dictionary of single key value pair
********************************************************************************
.. code-block:: python
>>> henley_on_thames_facts = {
... "area": "5.58 square meters",
... "population": "11,619",
... "civial parish": "Henley-on-Thames",
... "latitude": "51.536",
... "longitude": "-0.898"
... }
>>> p.save_as(adict=henley_on_thames_facts, dest_file_name='henley.xlsx')
Export a dictionary of single dimensonal array
********************************************************************************
.. code-block:: python
>>> ccs_insights = {
... "year": ["2017", "2018", "2019", "2020", "2021"],
... "smart phones": [1.53, 1.64, 1.74, 1.82, 1.90],
... "feature phones": [0.46, 0.38, 0.30, 0.23, 0.17]
... }
>>> p.save_as(adict=ccs_insights, dest_file_name='ccs.csv')
Export a dictionary of two dimensional array as a book
********************************************************************************
Suppose you want to save the below dictionary to an excel file :
.. code-block:: python
>>> a_dictionary_of_two_dimensional_arrays = {
... 'Sheet 1':
... [
... [1.0, 2.0, 3.0],
... [4.0, 5.0, 6.0],
... [7.0, 8.0, 9.0]
... ],
... 'Sheet 2':
... [
... ['X', 'Y', 'Z'],
... [1.0, 2.0, 3.0],
... [4.0, 5.0, 6.0]
... ],
... 'Sheet 3':
... [
... ['O', 'P', 'Q'],
... [3.0, 2.0, 1.0],
... [4.0, 3.0, 2.0]
... ]
... }
Here is the code:
.. code-block:: python
>>> p.save_book_as(
... bookdict=a_dictionary_of_two_dimensional_arrays,
... dest_file_name="book.xls"
... )
If you want to preserve the order of sheets in your dictionary, you have to
pass on an ordered dictionary to the function itself. For example:
.. code-block:: python
>>> data = OrderedDict()
>>> data.update({"Sheet 2": a_dictionary_of_two_dimensional_arrays['Sheet 2']})
>>> data.update({"Sheet 1": a_dictionary_of_two_dimensional_arrays['Sheet 1']})
>>> data.update({"Sheet 3": a_dictionary_of_two_dimensional_arrays['Sheet 3']})
>>> p.save_book_as(bookdict=data, dest_file_name="book.xls")
Let's verify its order:
.. code-block:: python
>>> book_dict = p.get_book_dict(file_name="book.xls")
>>> for key, item in book_dict.items():
... print(json.dumps({key: item}))
{"Sheet 2": [["X", "Y", "Z"], [1, 2, 3], [4, 5, 6]]}
{"Sheet 1": [[1, 2, 3], [4, 5, 6], [7, 8, 9]]}
{"Sheet 3": [["O", "P", "Q"], [3, 2, 1], [4, 3, 2]]}
Please notice that "Sheet 2" is the first item in the *book_dict*, meaning the order of sheets are preserved.
Transcoding
-------------------------------------------
.. note::
Please note that `pyexcel-cli` can perform file transcoding at command line.
No need to open your editor, save the problem, then python run.
The following code does a simple file format transcoding from xls to csv:
.. code-block:: python
>>> p.save_as(file_name="birth.xls", dest_file_name="birth.csv")
Again it is really simple. Let's verify what we have gotten:
.. code-block:: python
>>> sheet = p.get_sheet(file_name="birth.csv")
>>> sheet
birth.csv:
+-------+--------+----------+
| name | weight | birth |
+-------+--------+----------+
| Adam | 3.4 | 03/02/15 |
+-------+--------+----------+
| Smith | 4.2 | 12/11/14 |
+-------+--------+----------+
.. NOTE::
Please note that csv(comma separate value) file is pure text file. Formula, charts, images and formatting in xls file will disappear no matter which transcoding tool you use. Hence, pyexcel is a quick alternative for this transcoding job.
Let use previous example and save it as xlsx instead
.. code-block:: python
>>> p.save_as(file_name="birth.xls",
... dest_file_name="birth.xlsx") # change the file extension
Again let's verify what we have gotten:
.. code-block:: python
>>> sheet = p.get_sheet(file_name="birth.xlsx")
>>> sheet
pyexcel_sheet1:
+-------+--------+----------+
| name | weight | birth |
+-------+--------+----------+
| Adam | 3.4 | 03/02/15 |
+-------+--------+----------+
| Smith | 4.2 | 12/11/14 |
+-------+--------+----------+
Excel book merge and split operation in one line
--------------------------------------------------------------------------------
Merge all excel files in directory into a book where each file become a sheet
********************************************************************************
The following code will merge every excel files into one file, say "output.xls":
.. code-block:: python
from pyexcel.cookbook import merge_all_to_a_book
import glob
merge_all_to_a_book(glob.glob("your_csv_directory\*.csv"), "output.xls")
You can mix and match with other excel formats: xls, xlsm and ods. For example, if you are sure you have only xls, xlsm, xlsx, ods and csv files in `your_excel_file_directory`, you can do the following:
.. code-block:: python
from pyexcel.cookbook import merge_all_to_a_book
import glob
merge_all_to_a_book(glob.glob("your_excel_file_directory\*.*"), "output.xls")
Split a book into single sheet files
****************************************
Suppose you have many sheets in a work book and you would like to separate each into a single sheet excel file. You can easily do this:
.. code-block:: python
>>> from pyexcel.cookbook import split_a_book
>>> split_a_book("megabook.xls", "output.xls")
>>> import glob
>>> outputfiles = glob.glob("*_output.xls")
>>> for file in sorted(outputfiles):
... print(file)
...
Sheet 1_output.xls
Sheet 2_output.xls
Sheet 3_output.xls
for the output file, you can specify any of the supported formats
Extract just one sheet from a book
*************************************
Suppose you just want to extract one sheet from many sheets that exists in a work book and you would like to separate it into a single sheet excel file. You can easily do this:
.. code-block:: python
>>> from pyexcel.cookbook import extract_a_sheet_from_a_book
>>> extract_a_sheet_from_a_book("megabook.xls", "Sheet 1", "output.xls")
>>> if os.path.exists("Sheet 1_output.xls"):
... print("Sheet 1_output.xls exists")
...
Sheet 1_output.xls exists
for the output file, you can specify any of the supported formats
Hidden feature: partial read
===============================================
Most pyexcel users do not know, but other library users were requesting `partial read <https://github.com/jazzband/tablib/issues/467>`_
When you are dealing with huge amount of data, e.g. 64GB, obviously you would not
like to fill up your memory with those data. What you may want to do is, record
data from Nth line, take M records and stop. And you only want to use your memory
for the M records, not for beginning part nor for the tail part.
Hence partial read feature is developed to read partial data into memory for
processing.
You can paginate by row, by column and by both, hence you dictate what portion of the
data to read back. But remember only row limit features help you save memory. Let's
you use this feature to record data from Nth column, take M number of columns and skip
the rest. You are not going to reduce your memory footprint.
Why did not I see above benefit?
--------------------------------------------------------------------------------
This feature depends heavily on the implementation details.
`pyexcel-xls`_ (xlrd), `pyexcel-xlsx`_ (openpyxl), `pyexcel-ods`_ (odfpy) and
`pyexcel-ods3`_ (pyexcel-ezodf) will read all data into memory. Because xls,
xlsx and ods file are effective a zipped folder, all four will unzip the folder
and read the content in xml format in **full**, so as to make sense of all details.
Hence, during the partial data is been returned, the memory consumption won't
differ from reading the whole data back. Only after the partial
data is returned, the memory comsumption curve shall jump the cliff. So pagination
code here only limits the data returned to your program.
With that said, `pyexcel-xlsxr`_, `pyexcel-odsr`_ and `pyexcel-htmlr`_ DOES read
partial data into memory. Those three are implemented in such a way that they
consume the xml(html) when needed. When they have read designated portion of the
data, they stop, even if they are half way through.
In addition, pyexcel's csv readers can read partial data into memory too.
Let's assume the following file is a huge csv file:
.. code-block:: python
>>> import datetime
>>> import pyexcel as pe
>>> data = [
... [1, 21, 31],
... [2, 22, 32],
... [3, 23, 33],
... [4, 24, 34],
... [5, 25, 35],
... [6, 26, 36]
... ]
>>> pe.save_as(array=data, dest_file_name="your_file.csv")
And let's pretend to read partial data:
.. code-block:: python
>>> pe.get_sheet(file_name="your_file.csv", start_row=2, row_limit=3)
your_file.csv:
+---+----+----+
| 3 | 23 | 33 |
+---+----+----+
| 4 | 24 | 34 |
+---+----+----+
| 5 | 25 | 35 |
+---+----+----+
And you could as well do the same for columns:
.. code-block:: python
>>> pe.get_sheet(file_name="your_file.csv", start_column=1, column_limit=2)
your_file.csv:
+----+----+
| 21 | 31 |
+----+----+
| 22 | 32 |
+----+----+
| 23 | 33 |
+----+----+
| 24 | 34 |
+----+----+
| 25 | 35 |
+----+----+
| 26 | 36 |
+----+----+
Obvious, you could do both at the same time:
.. code-block:: python
>>> pe.get_sheet(file_name="your_file.csv",
... start_row=2, row_limit=3,
... start_column=1, column_limit=2)
your_file.csv:
+----+----+
| 23 | 33 |
+----+----+
| 24 | 34 |
+----+----+
| 25 | 35 |
+----+----+
The pagination support is available across all pyexcel plugins.
.. note::
No column pagination support for query sets as data source.
Formatting while transcoding a big data file
--------------------------------------------------------------------------------
If you are transcoding a big data set, conventional formatting method would not
help unless a on-demand free RAM is available. However, there is a way to minimize
the memory footprint of pyexcel while the formatting is performed.
Let's continue from previous example. Suppose we want to transcode "your_file.csv"
to "your_file.xls" but increase each element by 1.
What we can do is to define a row renderer function as the following:
.. code-block:: python
>>> def increment_by_one(row):
... for element in row:
... yield element + 1
Then pass it onto save_as function using row_renderer:
.. code-block:: python
>>> pe.isave_as(file_name="your_file.csv",
... row_renderer=increment_by_one,
... dest_file_name="your_file.xlsx")
.. note::
If the data content is from a generator, isave_as has to be used.
We can verify if it was done correctly:
.. code-block:: python
>>> pe.get_sheet(file_name="your_file.xlsx")
your_file.csv:
+---+----+----+
| 2 | 22 | 32 |
+---+----+----+
| 3 | 23 | 33 |
+---+----+----+
| 4 | 24 | 34 |
+---+----+----+
| 5 | 25 | 35 |
+---+----+----+
| 6 | 26 | 36 |
+---+----+----+
| 7 | 27 | 37 |
+---+----+----+
Stream APIs for big file : A set of two liners
================================================================================
When you are dealing with **BIG** excel files, you will want **pyexcel** to use
constant memory.
This section shows you how to get data from your **BIG** excel files and how to
export data to excel files in **two lines** at most, without eating all
your computer memory.
Two liners for get data from big excel files
--------------------------------------------------------------------------------
Get a list of dictionaries
********************************************************************************
Suppose you want to process the following coffee data again:
Top 5 coffeine drinks:
===================================== =============== =============
Coffees Serving Size Caffeine (mg)
Starbucks Coffee Blonde Roast venti(20 oz) 475
Dunkin' Donuts Coffee with Turbo Shot large(20 oz.) 398
Starbucks Coffee Pike Place Roast grande(16 oz.) 310
Panera Coffee Light Roast regular(16 oz.) 300
===================================== =============== =============
Let's get a list of dictionary out from the xls file:
.. code-block:: python
>>> records = p.iget_records(file_name="your_file.xls")
And let's check what do we have:
.. code-block:: python
>>> for r in records:
... print(f"{r['Serving Size']} of {r['Coffees']} has {r['Caffeine (mg)']} mg")
venti(20 oz) of Starbucks Coffee Blonde Roast has 475 mg
large(20 oz.) of Dunkin' Donuts Coffee with Turbo Shot has 398 mg
grande(16 oz.) of Starbucks Coffee Pike Place Roast has 310 mg
regular(16 oz.) of Panera Coffee Light Roast has 300 mg
Please do not forgot the second line to close the opened file handle:
.. code-block:: python
>>> p.free_resources()
Get two dimensional array
********************************************************************************
Instead, what if you have to use `pyexcel.get_array` to do the same:
.. code-block:: python
>>> for row in p.iget_array(file_name="your_file.xls", start_row=1):
... print(f"{row[1]} of {row[0]} has {row[2]} mg")
venti(20 oz) of Starbucks Coffee Blonde Roast has 475 mg
large(20 oz.) of Dunkin' Donuts Coffee with Turbo Shot has 398 mg
grande(16 oz.) of Starbucks Coffee Pike Place Roast has 310 mg
regular(16 oz.) of Panera Coffee Light Roast has 300 mg
Again, do not forgot the second line:
.. code-block:: python
>>> p.free_resources()
where `start_row` skips the header row.
Data export in one liners
---------------------------------------------
Export an array
**********************
Suppose you have the following array:
.. code-block:: python
>>> data = [[1, 2, 3], [4, 5, 6], [7, 8, 9]]
And here is the code to save it as an excel file :
.. code-block:: python
>>> p.isave_as(array=data, dest_file_name="example.xls")
But the following line is not required because the data source
are not file sources:
.. code-block:: python
>>> # p.free_resources()
Let's verify it:
.. code-block:: python
>>> p.get_sheet(file_name="example.xls")
pyexcel_sheet1:
+---+---+---+
| 1 | 2 | 3 |
+---+---+---+
| 4 | 5 | 6 |
+---+---+---+
| 7 | 8 | 9 |
+---+---+---+
And here is the code to save it as a csv file :
.. code-block:: python
>>> p.isave_as(array=data,
... dest_file_name="example.csv",
... dest_delimiter=':')
Let's verify it:
.. code-block:: python
>>> with open("example.csv") as f:
... for line in f.readlines():
... print(line.rstrip())
...
1:2:3
4:5:6
7:8:9
Export a list of dictionaries
**********************************
.. code-block:: python
>>> records = [
... {"year": 1903, "country": "Germany", "speed": "206.7km/h"},
... {"year": 1964, "country": "Japan", "speed": "210km/h"},
... {"year": 2008, "country": "China", "speed": "350km/h"}
... ]
>>> p.isave_as(records=records, dest_file_name='high_speed_rail.xls')
Export a dictionary of single key value pair
********************************************************************************
.. code-block:: python
>>> henley_on_thames_facts = {
... "area": "5.58 square meters",
... "population": "11,619",
... "civial parish": "Henley-on-Thames",
... "latitude": "51.536",
... "longitude": "-0.898"
... }
>>> p.isave_as(adict=henley_on_thames_facts, dest_file_name='henley.xlsx')
Export a dictionary of single dimensonal array
********************************************************************************
.. code-block:: python
>>> ccs_insights = {
... "year": ["2017", "2018", "2019", "2020", "2021"],
... "smart phones": [1.53, 1.64, 1.74, 1.82, 1.90],
... "feature phones": [0.46, 0.38, 0.30, 0.23, 0.17]
... }
>>> p.isave_as(adict=ccs_insights, dest_file_name='ccs.csv')
>>> p.free_resources()
Export a dictionary of two dimensional array as a book
********************************************************************************
Suppose you want to save the below dictionary to an excel file :
.. code-block:: python
>>> a_dictionary_of_two_dimensional_arrays = {
... 'Sheet 1':
... [
... [1.0, 2.0, 3.0],
... [4.0, 5.0, 6.0],
... [7.0, 8.0, 9.0]
... ],
... 'Sheet 2':
... [
... ['X', 'Y', 'Z'],
... [1.0, 2.0, 3.0],
... [4.0, 5.0, 6.0]
... ],
... 'Sheet 3':
... [
... ['O', 'P', 'Q'],
... [3.0, 2.0, 1.0],
... [4.0, 3.0, 2.0]
... ]
... }
Here is the code:
.. code-block:: python
>>> p.isave_book_as(
... bookdict=a_dictionary_of_two_dimensional_arrays,
... dest_file_name="book.xls"
... )
If you want to preserve the order of sheets in your dictionary, you have to
pass on an ordered dictionary to the function itself. For example:
.. code-block:: python
>>> from pyexcel._compact import OrderedDict
>>> data = OrderedDict()
>>> data.update({"Sheet 2": a_dictionary_of_two_dimensional_arrays['Sheet 2']})
>>> data.update({"Sheet 1": a_dictionary_of_two_dimensional_arrays['Sheet 1']})
>>> data.update({"Sheet 3": a_dictionary_of_two_dimensional_arrays['Sheet 3']})
>>> p.isave_book_as(bookdict=data, dest_file_name="book.xls")
>>> p.free_resources()
Let's verify its order:
.. code-block:: python
>>> import json
>>> book_dict = p.get_book_dict(file_name="book.xls")
>>> for key, item in book_dict.items():
... print(json.dumps({key: item}))
{"Sheet 2": [["X", "Y", "Z"], [1, 2, 3], [4, 5, 6]]}
{"Sheet 1": [[1, 2, 3], [4, 5, 6], [7, 8, 9]]}
{"Sheet 3": [["O", "P", "Q"], [3, 2, 1], [4, 3, 2]]}
Please notice that "Sheet 2" is the first item in the *book_dict*, meaning the order of sheets are preserved.
File format transcoding on one line
-------------------------------------------
.. note::
Please note that the following file transcoding could be with zero line. Please
install pyexcel-cli and you will do the transcode in one command. No need to
open your editor, save the problem, then python run.
The following code does a simple file format transcoding from xls to csv:
.. code-block:: python
>>> import pyexcel
>>> p.save_as(file_name="birth.xls", dest_file_name="birth.csv")
Again it is really simple. Let's verify what we have gotten:
.. code-block:: python
>>> sheet = p.get_sheet(file_name="birth.csv")
>>> sheet
birth.csv:
+-------+--------+----------+
| name | weight | birth |
+-------+--------+----------+
| Adam | 3.4 | 03/02/15 |
+-------+--------+----------+
| Smith | 4.2 | 12/11/14 |
+-------+--------+----------+
.. note::
Please note that csv(comma separate value) file is pure text file. Formula, charts, images and formatting in xls file will disappear no matter which transcoding tool you use. Hence, pyexcel is a quick alternative for this transcoding job.
Let use previous example and save it as xlsx instead
.. code-block:: python
>>> import pyexcel
>>> p.isave_as(file_name="birth.xls",
... dest_file_name="birth.xlsx") # change the file extension
Again let's verify what we have gotten:
.. code-block:: python
>>> sheet = p.get_sheet(file_name="birth.xlsx")
>>> sheet
pyexcel_sheet1:
+-------+--------+----------+
| name | weight | birth |
+-------+--------+----------+
| Adam | 3.4 | 03/02/15 |
+-------+--------+----------+
| Smith | 4.2 | 12/11/14 |
+-------+--------+----------+
Available Plugins
=================
.. _file-format-list:
.. _a-map-of-plugins-and-file-formats:
.. table:: A list of file formats supported by external plugins
======================== ======================= =================
Package name Supported file formats Dependencies
======================== ======================= =================
`pyexcel-io`_ csv, csvz [#f1]_, tsv,
tsvz [#f2]_
`pyexcel-xls`_ xls, xlsx(read only), `xlrd`_,
xlsm(read only) `xlwt`_
`pyexcel-xlsx`_ xlsx `openpyxl`_
`pyexcel-ods3`_ ods `pyexcel-ezodf`_,
lxml
`pyexcel-ods`_ ods `odfpy`_
======================== ======================= =================
.. table:: Dedicated file reader and writers
======================== ======================= =================
Package name Supported file formats Dependencies
======================== ======================= =================
`pyexcel-xlsxw`_ xlsx(write only) `XlsxWriter`_
`pyexcel-libxlsxw`_ xlsx(write only) `libxlsxwriter`_
`pyexcel-xlsxr`_ xlsx(read only) lxml
`pyexcel-xlsbr`_ xlsb(read only) pyxlsb
`pyexcel-odsr`_ read only for ods, fods lxml
`pyexcel-odsw`_ write only for ods loxun
`pyexcel-htmlr`_ html(read only) lxml,html5lib
`pyexcel-pdfr`_ pdf(read only) camelot
======================== ======================= =================
Plugin shopping guide
------------------------
Since 2020, all pyexcel-io plugins have dropped the support for python versions
which are lower than 3.6. If you want to use any of those Python versions, please use pyexcel-io
and its plugins versions that are lower than 0.6.0.
Except csv files, xls, xlsx and ods files are a zip of a folder containing a lot of
xml files
The dedicated readers for excel files can stream read
In order to manage the list of plugins installed, you need to use pip to add or remove
a plugin. When you use virtualenv, you can have different plugins per virtual
environment. In the situation where you have multiple plugins that does the same thing
in your environment, you need to tell pyexcel which plugin to use per function call.
For example, pyexcel-ods and pyexcel-odsr, and you want to get_array to use pyexcel-odsr.
You need to append get_array(..., library='pyexcel-odsr').
.. _pyexcel-io: https://github.com/pyexcel/pyexcel-io
.. _pyexcel-xls: https://github.com/pyexcel/pyexcel-xls
.. _pyexcel-xlsx: https://github.com/pyexcel/pyexcel-xlsx
.. _pyexcel-ods: https://github.com/pyexcel/pyexcel-ods
.. _pyexcel-ods3: https://github.com/pyexcel/pyexcel-ods3
.. _pyexcel-odsr: https://github.com/pyexcel/pyexcel-odsr
.. _pyexcel-odsw: https://github.com/pyexcel/pyexcel-odsw
.. _pyexcel-pdfr: https://github.com/pyexcel/pyexcel-pdfr
.. _pyexcel-xlsxw: https://github.com/pyexcel/pyexcel-xlsxw
.. _pyexcel-libxlsxw: https://github.com/pyexcel/pyexcel-libxlsxw
.. _pyexcel-xlsxr: https://github.com/pyexcel/pyexcel-xlsxr
.. _pyexcel-xlsbr: https://github.com/pyexcel/pyexcel-xlsbr
.. _pyexcel-htmlr: https://github.com/pyexcel/pyexcel-htmlr
.. _xlrd: https://github.com/python-excel/xlrd
.. _xlwt: https://github.com/python-excel/xlwt
.. _openpyxl: https://bitbucket.org/openpyxl/openpyxl
.. _XlsxWriter: https://github.com/jmcnamara/XlsxWriter
.. _pyexcel-ezodf: https://github.com/pyexcel/pyexcel-ezodf
.. _odfpy: https://github.com/eea/odfpy
.. _libxlsxwriter: http://libxlsxwriter.github.io/getting_started.html
.. table:: Other data renderers
======================== ======================= ================= ==================
Package name Supported file formats Dependencies Python versions
======================== ======================= ================= ==================
`pyexcel-text`_ write only:rst, `tabulate`_ 2.6, 2.7, 3.3, 3.4
mediawiki, html, 3.5, 3.6, pypy
latex, grid, pipe,
orgtbl, plain simple
read only: ndjson
r/w: json
`pyexcel-handsontable`_ handsontable in html `handsontable`_ same as above
`pyexcel-pygal`_ svg chart `pygal`_ 2.7, 3.3, 3.4, 3.5
3.6, pypy
`pyexcel-sortable`_ sortable table in html `csvtotable`_ same as above
`pyexcel-gantt`_ gantt chart in html `frappe-gantt`_ except pypy, same
as above
======================== ======================= ================= ==================
.. _pyexcel-text: https://github.com/pyexcel/pyexcel-text
.. _tabulate: https://bitbucket.org/astanin/python-tabulate
.. _pyexcel-handsontable: https://github.com/pyexcel/pyexcel-handsontable
.. _handsontable: https://cdnjs.com/libraries/handsontable
.. _pyexcel-pygal: https://github.com/pyexcel/pyexcel-chart
.. _pygal: https://github.com/Kozea/pygal
.. _pyexcel-matplotlib: https://github.com/pyexcel/pyexcel-matplotlib
.. _matplotlib: https://matplotlib.org
.. _pyexcel-sortable: https://github.com/pyexcel/pyexcel-sortable
.. _csvtotable: https://github.com/vividvilla/csvtotable
.. _pyexcel-gantt: https://github.com/pyexcel/pyexcel-gantt
.. _frappe-gantt: https://github.com/frappe/gantt
.. rubric:: Footnotes
.. [#f1] zipped csv file
.. [#f2] zipped tsv file
Acknowledgement
===============
All great work have been done by odf, ezodf, xlrd, xlwt, tabulate and other
individual developers. This library unites only the data access code.
License
================================================================================
New BSD License
19 contributors
================================================================================
In alphabetical order:
* `Akshaya Kumar Sharma <https://github.com/akshayakrsh>`_
* `Andre Almar <https://github.com/andrealmar>`_
* `Arunkumar Rajendran <https://github.com/arunkumar-ra>`_
* `Ayan Banerjee <https://github.com/ayan-b>`_
* `Chris Hill-Scott <https://github.com/quis>`_
* `Craig Anderson <https://github.com/craiga>`_
* `Daryl Yu <https://github.com/darylyu>`_
* `J Harley <https://github.com/julzhk>`_
* `Joel Nothman <https://github.com/jnothman>`_
* `John Vandenberg <https://github.com/jayvdb>`_
* `Linghui Zeng <https://github.com/mathsyouth>`_
* `Nik Nyby <https://github.com/nikolas>`_
* `Rintze M. Zelle, PhD <https://github.com/rmzelle>`_
* `Simeon Visser <https://github.com/svisser>`_
* `Simon Allen <https://github.com/garfunkel>`_
* `simon klemenc <https://github.com/hiaselhans>`_
* `Tim Gates <https://github.com/timgates42>`_
* `Wesley A. Cheng <https://github.com/wesleyacheng>`_
* `William Jamir Silva <https://github.com/williamjamir>`_
Change log
================================================================================
0.7.0 - 12.2.2022
--------------------------------------------------------------------------------
**Fixed**
#. `#250 <https://github.com/pyexcel/pyexcel/issues/250>`_: RecursionError
raised on deepcopy of a sheet
**Updated**
#. `#255 <https://github.com/pyexcel/pyexcel/issues/255>`_: pyexcel.get_array
documentation page seems to be a copy of pyexcel.get_sheet
**Removed**
#. `#249 <https://github.com/pyexcel/pyexcel/issues/249>`_: drop the support for
dummy import statements pyexcel.ext.*
0.6.7 - 12.09.2021
--------------------------------------------------------------------------------
**Updated**
#. `#243 <https://github.com/pyexcel/pyexcel/issues/243>`_: fix small typo.
#. add chardet as explicit dependency
0.6.6 - 14.11.2020
--------------------------------------------------------------------------------
**Updated**
#. `#233 <https://github.com/pyexcel/pyexcel/issues/233>`_: dynamically resize
the table matrix on set_value. sheet['AA1'] = 'test' will work in this
release.
0.6.5 - 8.10.2020
--------------------------------------------------------------------------------
**Updated**
#. update queryset source to work with pyexcel-io 0.6.0
0.6.4 - 18.08.2020
--------------------------------------------------------------------------------
**Updated**
#. `#219 <https://github.com/pyexcel/pyexcel/issues/219>`_: book created from
dict no longer discards order.
0.6.3 - 01.08.2020
--------------------------------------------------------------------------------
**fixed**
#. `#214 <https://github.com/pyexcel/pyexcel/issues/214>`_: remove leading and
trailing whitespace for column names
**removed**
#. python 2 compatibility have been permanently removed.
0.6.2 - 8.06.2020
--------------------------------------------------------------------------------
**fixed**
#. `#109 <https://github.com/pyexcel/pyexcel/issues/109>`_: Control the column
order when write the data output
0.6.1 - 02.05.2020
--------------------------------------------------------------------------------
**fixed**
#. `#203 <https://github.com/pyexcel/pyexcel/issues/203>`_: texttable was
dropped out in 0.6.0 as compulsary dependency. end user may experience it
when a sheet/table is printed in a shell. otherwise, new user of pyexcel
won't see it. As of release date, no issues were created
0.6.0 - 21.04.2020
--------------------------------------------------------------------------------
**updated**
#. `#199 <https://github.com/pyexcel/pyexcel/issues/199>`_: += in place; = +
shall return new instance
#. `#195 <https://github.com/pyexcel/pyexcel/issues/195>`_: documentation
update. however small is welcome
**removed**
#. Dropping the test support for python version lower than 3.6. v0.6.0 should
work with python 2.7 but is not guaranteed to work. Please upgrade to python
3.6+.
0.5.15 - 07.07.2019
--------------------------------------------------------------------------------
**updated**
#. `#185 <https://github.com/pyexcel/pyexcel/issues/185>`_: fix a bug with http
data source. The real fix lies in pyexcel-io v0.5.19. this release just put
the version requirement in.
0.5.14 - 12.06.2019
--------------------------------------------------------------------------------
**updated**
#. `#182 <https://github.com/pyexcel/pyexcel/issues/182>`_: support
dest_force_file_type on save_as and save_book_as
0.5.13 - 12.03.2019
--------------------------------------------------------------------------------
**updated**
#. `#176 <https://github.com/pyexcel/pyexcel/issues/176>`_: get_sheet
{IndexError}list index out of range // XLSX can't be opened
0.5.12 - 25.02.2019
--------------------------------------------------------------------------------
**updated**
#. `#174 <https://github.com/pyexcel/pyexcel/issues/174>`_: include examples in
tarbar
0.5.11 - 22.02.2019
--------------------------------------------------------------------------------
**updated**
#. `#169 <https://github.com/pyexcel/pyexcel/issues/169>`_: remove
pyexcel-handsontalbe in test
#. add tests, and docs folder in distribution
0.5.10 - 3.12.2018
--------------------------------------------------------------------------------
**updated**
#. `#157 <https://github.com/pyexcel/pyexcel/issues/157>`_: Please use
scan_plugins_regex, which lml 0.7 complains about
#. updated dependency on pyexcel-io to 0.5.11
0.5.9.1 - 30.08.2018
--------------------------------------------------------------------------------
**updated**
#. to require pyexcel-io 0.5.9.1 and use lml at least version 0.0.2
0.5.9 - 30.08.2018
--------------------------------------------------------------------------------
**added**
#. support __len__. len(book) returns the number of sheets and len(sheet)
returns the number of rows
#. `#144 <https://github.com/pyexcel/pyexcel/issues/144>`_: memory-efficient way
to read sheet names.
#. `#148 <https://github.com/pyexcel/pyexcel/issues/148>`_: force_file_type is
introduced. When reading a file on a disk, this parameter allows you to
choose a reader. i.e. csv reader for a text file. xlsx reader for a xlsx file
but with .blob file suffix.
#. finally, pyexcel got import pyexcel.__version__
**updated**
#. Sheet.to_records() returns a generator now, saving memory
#. `#115 <https://github.com/pyexcel/pyexcel/issues/115>`_, Fix set membership
test to run faster in python2
#. `#140 <https://github.com/pyexcel/pyexcel/issues/140>`_, Direct writes to
cells yield weird results
0.5.8 - 26.03.2018
--------------------------------------------------------------------------------
**added**
#. `#125 <https://github.com/pyexcel/pyexcel/issues/125>`_, sort book sheets
**updated**
#. `#126 <https://github.com/pyexcel/pyexcel/issues/126>`_, dest_sheet_name in
save_as will set the sheet name in the output
#. `#115 <https://github.com/pyexcel/pyexcel/issues/115>`_, Fix set membership
test to run faster in python2
0.5.7 - 11.01.2018
--------------------------------------------------------------------------------
**added**
#. `pyexcel-io#46 <https://github.com/pyexcel/pyexcel-io/issues/46>`_, expose
`bulk_save` to developer.
0.5.6 - 23.10.2017
--------------------------------------------------------------------------------
**removed**
#. `#105 <https://github.com/pyexcel/pyexcel/issues/105>`_, remove gease from
setup_requires, introduced by 0.5.5.
#. removed testing against python 2.6
#. `#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.5 - 20.10.2017
--------------------------------------------------------------------------------
**removed**
#. `#105 <https://github.com/pyexcel/pyexcel/issues/105>`_, remove gease from
setup_requires, introduced by 0.5.5.
#. removed testing against python 2.6
#. `#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.4 - 27.09.2017
--------------------------------------------------------------------------------
**fixed**
#. `#100 <https://github.com/pyexcel/pyexcel/issues/100>`_, Sheet.to_dict() gets
out of range error because there is only one row.
**updated**
#. Updated the baseline of pyexcel-io to 0.5.1.
0.5.3 - 01-08-2017
--------------------------------------------------------------------------------
**added**
#. `#95 <https://github.com/pyexcel/pyexcel/issues/95>`_, respect the order of
records in iget_records, isave_as and save_as.
#. `#97 <https://github.com/pyexcel/pyexcel/issues/97>`_, new feature to allow
intuitive initialization of pyexcel.Book.
0.5.2 - 26-07-2017
--------------------------------------------------------------------------------
**Updated**
#. embeded the enabler for pyexcel-htmlr. http source does not support text/html
as mime type.
0.5.1 - 12.06.2017
--------------------------------------------------------------------------------
**Updated**
#. support saving SheetStream and BookStream to database targets. This is needed
for pyexcel-webio and its downstream projects.
0.5.0 - 19.06.2017
--------------------------------------------------------------------------------
**Added**
#. Sheet.top() and Sheet.top_left() for data browsing
#. add html as default rich display in Jupyter notebook when pyexcel-text and
pyexcel-chart is installed
#. add svg as default rich display in Jupyter notebook when pyexcel-chart and
one of its implementation plugin(pyexcel-pygal, etc.) are is installed
#. new dictionary source supported: a dictionary of key value pair could be read
into a sheet.
#. added dynamic external plugin loading. meaning if a pyexcel plugin is
installed, it will be loaded implicitly. And this change would remove
unnecessary info log for those who do not use pyexcel-text and pyexcel-gal
#. save_book_as before 0.5.0 becomes isave_book_as and save_book_as in 0.5.0
convert BookStream to Book before saving.
#. `#83 <https://github.com/pyexcel/pyexcel/issues/83>`_, file closing mechanism
is enfored. free_resource is added and it should be called when iget_array,
iget_records, isave_as and/or isave_book_as are used.
**Updated**
#. array is passed to pyexcel.Sheet as reference. it means your array data will
be modified.
**Removed**
#. pyexcel.Writer and pyexcel.BookWriter were removed
#. pyexcel.load_book_from_sql and pyexcel.load_from_sql were removed
#. pyexcel.deprecated.load_from_query_sets,
pyexcel.deprecated.load_book_from_django_models and
pyexcel.deprecated.load_from_django_model were removed
#. Removed plugin loading code and lml is used instead
0.4.5 - 17.03.2017
--------------------------------------------------------------------------------
**Updated**
#. `#80 <https://github.com/pyexcel/pyexcel/issues/80>`_: remove pyexcel-chart
import from v0.4.x
0.4.4 - 06.02.2017
--------------------------------------------------------------------------------
**Updated**
#. `#68 <https://github.com/pyexcel/pyexcel/issues/68>`_: regression
save_to_memory() should have returned a stream instance which has been reset
to zero if possible. The exception is sys.stdout, which cannot be reset.
#. `#74 <https://github.com/pyexcel/pyexcel/issues/74>`_: Not able to handle
decimal.Decimal
**Removed**
#. remove get_{{file_type}}_stream functions from pyexcel.Sheet and pyexcel.Book
introduced since 0.4.3.
0.4.3 - 26.01.2017
--------------------------------------------------------------------------------
**Added**
#. '.stream' attribute are attached to `~pyexcel.Sheet` and `~pyexcel.Book` to
get direct access the underneath stream in responding to file type
attributes, such as sheet.xls. it helps provide a custom stream to external
world, for example, Sheet.stream.csv gives a text stream that contains csv
formatted data. Book.stream.xls returns a xls format data in a byte stream.
**Updated**
#. Better error reporting when an unknown parameters or unsupported file types
were given to the signature functions.
0.4.2 - 17.01.2017
--------------------------------------------------------------------------------
**Updated**
#. Raise exception if the incoming sheet does not have column names. In other
words, only sheet with column names could be saved to database. sheet with
row names cannot be saved. The alternative is to transpose the sheet, then
name_columns_by_row and then save.
#. fix iget_records where a non-uniform content should be given, e.g. [["x",
"y"], [1, 2], [3]], some record would become non-uniform, e.g. key 'y' would
be missing from the second record.
#. `skip_empty_rows` is applicable when saving a python data structure to
another data source. For example, if your array contains a row which is
consisted of empty string, such as ['', '', '' ... ''], please specify
`skip_empty_rows=False` in order to preserve it. This becomes subtle when you
try save a python dictionary where empty rows is not easy to be spotted.
#. `#69 <https://github.com/pyexcel/pyexcel/issues/69>`_: better documentation
for save_book_as.
0.4.1 - 23.12.2016
--------------------------------------------------------------------------------
**Updated**
#. `#68 <https://github.com/pyexcel/pyexcel/issues/68>`_: regression
save_to_memory() should have returned a stream instance.
0.4.0 - 22.12.2016
--------------------------------------------------------------------------------
**Added**
#. `Flask-Excel#19 <https://github.com/pyexcel/Flask-Excel/issues/19>`_ allow
sheet_name parameter
#. `pyexcel-xls#11 <https://github.com/pyexcel/pyexcel-xls/issues/11>`_
case-insensitive for file_type. `xls` and `XLS` are treated in the same way
**Updated**
#. `#66 <https://github.com/pyexcel/pyexcel/issues/66>`_: `export_columns` is
ignored
#. Update dependency on pyexcel-io v0.3.0
0.3.3 - 07.11.2016
--------------------------------------------------------------------------------
**Updated**
#. `#63 <https://github.com/pyexcel/pyexcel/issues/63>`_: cannot display empty
sheet(hence book with empty sheet) as texttable
0.3.2 - 02.11.2016
--------------------------------------------------------------------------------
**Updated**
#. `#62 <https://github.com/pyexcel/pyexcel/issues/62>`_: optional module import
error become visible.
0.3.0 - 28.10.2016
--------------------------------------------------------------------------------
**Added:**
#. file type setters for Sheet and Book, and its documentation
#. `iget_records` returns a generator for a list of records and should have
better memory performance, especially dealing with large csv files.
#. `iget_array` returns a generator for a list of two dimensional array and
should have better memory performance, especially dealing with large csv
files.
#. Enable pagination support, and custom row renderer via pyexcel-io v0.2.3
**Updated**
#. Take `isave_as` out from `save_as`. Hence two functions are there for save a
sheet as
#. `#60 <https://github.com/pyexcel/pyexcel/issues/60>`_: encode 'utf-8' if the
console is of ascii encoding.
#. `#59 <https://github.com/pyexcel/pyexcel/issues/59>`_: custom row renderer
#. `#56 <https://github.com/pyexcel/pyexcel/issues/56>`_: set cell value does
not work
#. pyexcel.transpose becomes `pyexcel.sheets.transpose`
#. iterator functions of `pyexcel.Sheet` were converted to generator functions
* `pyexcel.Sheet.enumerate()`
* `pyexcel.Sheet.reverse()`
* `pyexcel.Sheet.vertical()`
* `pyexcel.Sheet.rvertical()`
* `pyexcel.Sheet.rows()`
* `pyexcel.Sheet.rrows()`
* `pyexcel.Sheet.columns()`
* `pyexcel.Sheet.rcolumns()`
* `pyexcel.Sheet.named_rows()`
* `pyexcel.Sheet.named_columns()`
#. `~pyexcel.Sheet.save_to_memory` and `~pyexcel.Book.save_to_memory` return the
actual content. No longer they will return a io object hence you cannot call
getvalue() on them.
**Removed:**
#. `content` and `out_file` as function parameters to the signature functions
are no longer supported.
#. SourceFactory and RendererFactory are removed
#. The following methods are removed
* `pyexcel.to_array`
* `pyexcel.to_dict`
* `pyexcel.utils.to_one_dimensional_array`
* `pyexcel.dict_to_array`
* `pyexcel.from_records`
* `pyexcel.to_records`
#. `pyexcel.Sheet.filter` has been re-implemented and all filters were removed:
* `pyexcel.filters.ColumnIndexFilter`
* `pyexcel.filters.ColumnFilter`
* `pyexcel.filters.RowFilter`
* `pyexcel.filters.EvenColumnFilter`
* `pyexcel.filters.OddColumnFilter`
* `pyexcel.filters.EvenRowFilter`
* `pyexcel.filters.OddRowFilter`
* `pyexcel.filters.RowIndexFilter`
* `pyexcel.filters.SingleColumnFilter`
* `pyexcel.filters.RowValueFilter`
* `pyexcel.filters.NamedRowValueFilter`
* `pyexcel.filters.ColumnValueFilter`
* `pyexcel.filters.NamedColumnValueFilter`
* `pyexcel.filters.SingleRowFilter`
#. the following functions have been removed
* `add_formatter`
* `remove_formatter`
* `clear_formatters`
* `freeze_formatters`
* `add_filter`
* `remove_filter`
* `clear_filters`
* `freeze_formatters`
#. `pyexcel.Sheet.filter` has been re-implemented and all filters were removed:
* pyexcel.formatters.SheetFormatter
0.2.5 - 31.08.2016
--------------------------------------------------------------------------------
**Updated:**
#. `#58 <https://github.com/pyexcel/pyexcel/issues/58>`_: texttable should have
been made as compulsory requirement
0.2.4 - 14.07.2016
--------------------------------------------------------------------------------
**Updated:**
#. For python 2, writing to sys.stdout by pyexcel-cli raise IOError.
0.2.3 - 11.07.2016
--------------------------------------------------------------------------------
**Updated:**
#. For python 3, do not seek 0 when saving to memory if sys.stdout is passed on.
Hence, adding support for sys.stdin and sys.stdout.
0.2.2 - 01.06.2016
--------------------------------------------------------------------------------
**Updated:**
#. Explicit imports, no longer needed
#. Depends on latest setuptools 18.0.1
#. NotImplementedError will be raised if parameters to core functions are not
supported, e.g. get_sheet(cannot_find_me_option="will be thrown out as
NotImplementedError")
0.2.1 - 23.04.2016
--------------------------------------------------------------------------------
**Added:**
#. add pyexcel-text file types as attributes of pyexcel.Sheet and pyexcel.Book,
related to `#31 <https://github.com/pyexcel/pyexcel/issues/31>`__
#. auto import pyexcel-text if it is pip installed
**Updated:**
#. code refactoring done for easy addition of sources.
#. bug fix `#29 <https://github.com/pyexcel/pyexcel/issues/29>`__, Even if the
format is a string it is displayed as a float
#. pyexcel-text is no longer a plugin to pyexcel-io but to pyexcel.sources, see
`pyexcel-text#22 <https://github.com/pyexcel/pyexcel-text/issues/22>`__
**Removed:**
#. pyexcel.presentation is removed. No longer the internal decorate @outsource
is used. related to `#31 <https://github.com/pyexcel/pyexcel/issues/31>`_
0.2.0 - 17.01.2016
--------------------------------------------------------------------------------
**Updated**
#. adopt pyexcel-io yield key word to return generator as content
#. pyexcel.save_as and pyexcel.save_book_as get performance improvements
0.1.7 - 03.07.2015
--------------------------------------------------------------------------------
**Added**
#. Support pyramid-excel which does the database commit on its own.
0.1.6 - 13.06.2015
--------------------------------------------------------------------------------
**Added**
#. get excel data from a http url
0.0.13 - 07.02.2015
--------------------------------------------------------------------------------
**Added**
#. Support django
#. texttable as default renderer
0.0.12 - 25.01.2015
--------------------------------------------------------------------------------
**Added**
#. Added sqlalchemy support
0.0.10 - 15.12.2015
--------------------------------------------------------------------------------
**Added**
#. added csvz and tsvz format
0.0.4 - 12.10.2014
--------------------------------------------------------------------------------
**Updated**
#. Support python 3
0.0.1 - 14.09.2014
--------------------------------------------------------------------------------
**Features:**
#. read and write csv, ods, xls, xlsx and xlsm files(which are referred later as
excel files)
#. various iterators for the reader
#. row and column filters for the reader
#. utilities to get array and dictionary out from excel files.
#. cookbok receipes for some common and simple usage of this library.
Raw data
{
"_id": null,
"home_page": "https://github.com/pyexcel/pyexcel",
"name": "pyexcel",
"maintainer": "",
"docs_url": "https://pythonhosted.org/pyexcel/",
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "python,tsv,tsvzcsv,csvz,xls,xlsx,ods",
"author": "C.W.",
"author_email": "info@pyexcel.org",
"download_url": "https://files.pythonhosted.org/packages/70/31/93b6fcabe8c74151952d57df762ee179dca96316232716ec3cdacdaaf0c9/pyexcel-0.7.0.tar.gz",
"platform": "",
"description": "================================================================================\npyexcel - Let you focus on data, instead of file formats\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/workflows/run_tests/badge.svg\n :target: http://github.com/pyexcel/pyexcel/actions\n\n.. image:: https://codecov.io/gh/pyexcel/pyexcel/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/pyexcel/pyexcel\n\n.. image:: https://badge.fury.io/py/pyexcel.svg\n :target: https://pypi.org/project/pyexcel\n\n.. image:: https://anaconda.org/conda-forge/pyexcel/badges/version.svg\n :target: https://anaconda.org/conda-forge/pyexcel\n\n.. image:: https://pepy.tech/badge/pyexcel/month\n :target: https://pepy.tech/project/pyexcel\n\n.. image:: https://anaconda.org/conda-forge/pyexcel/badges/downloads.svg\n :target: https://anaconda.org/conda-forge/pyexcel\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.. image:: https://readthedocs.org/projects/pyexcel/badge/?version=latest\n :target: http://pyexcel.readthedocs.org/en/latest/\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\nIntroduction\n================================================================================\n\nFeature Highlights\n===================\n\n.. table:: A list of supported file formats\n\n ============ =======================================================\n file format definition\n ============ =======================================================\n csv comma separated values\n tsv tab separated values\n csvz a zip file that contains one or many csv files\n tsvz a zip file that contains one or many tsv files\n xls a spreadsheet file format created by\n MS-Excel 97-2003 \n xlsx MS-Excel Extensions to the Office Open XML\n SpreadsheetML File Format.\n xlsm an MS-Excel Macro-Enabled Workbook file\n ods open document spreadsheet\n fods flat open document spreadsheet\n json java script object notation\n html html table of the data structure\n simple simple presentation\n rst rStructured Text presentation of the data\n mediawiki media wiki table\n ============ =======================================================\n\n\n.. image:: https://github.com/pyexcel/pyexcel/raw/dev/docs/source/_static/images/architecture.svg\n\n\n1. One application programming interface(API) to handle multiple data sources:\n\n * physical file\n * memory file\n * SQLAlchemy table\n * Django Model\n * Python data structures: dictionary, records and array\n\n2. One API to read and write data in various excel file formats.\n3. For large data sets, data streaming are supported. A genenerator can be returned to you. Checkout iget_records, iget_array, isave_as and isave_book_as.\n\n\n\n\nInstallation\n================================================================================\n\nYou can install pyexcel via pip:\n\n.. code-block:: bash\n\n $ pip install pyexcel\n\n\nor clone it and install it:\n\n.. code-block:: bash\n\n $ git clone https://github.com/pyexcel/pyexcel.git\n $ cd pyexcel\n $ python setup.py install\n\n\n\nOne liners\n================================================================================\n\nThis section shows you how to get data from your excel files and how to\nexport data to excel files in **one line**\n\nRead from the excel files\n--------------------------------------------------------------------------------\n\nGet a list of dictionaries\n********************************************************************************\n\n\nSuppose you want to process `History of Classical Music <https://www.naxos.com/education/brief_history.asp>`_:\n\n\nHistory of Classical Music:\n\n=============== ============= ====================================\nName Period Representative Composers\nMedieval c.1150-c.1400 Machaut, Landini\nRenaissance c.1400-c.1600 Gibbons, Frescobaldi\nBaroque c.1600-c.1750 JS Bach, Vivaldi\nClassical c.1750-c.1830 Joseph Haydn, Wolfgan Amadeus Mozart\nEarley Romantic c.1830-c.1860 Chopin, Mendelssohn, Schumann, Liszt\nLate Romantic c.1860-c.1920 Wagner,Verdi\n=============== ============= ====================================\n\n\nLet's get a list of dictionary out from the xls file:\n\n.. code-block:: python\n\n >>> records = p.get_records(file_name=\"your_file.xls\")\n\nAnd let's check what do we have:\n\n.. code-block:: python\n\n >>> for row in records:\n ... print(f\"{row['Representative Composers']} are from {row['Name']} period ({row['Period']})\")\n Machaut, Landini are from Medieval period (c.1150-c.1400)\n Gibbons, Frescobaldi are from Renaissance period (c.1400-c.1600)\n JS Bach, Vivaldi are from Baroque period (c.1600-c.1750)\n Joseph Haydn, Wolfgan Amadeus Mozart are from Classical period (c.1750-c.1830)\n Chopin, Mendelssohn, Schumann, Liszt are from Earley Romantic period (c.1830-c.1860)\n Wagner,Verdi are from Late Romantic period (c.1860-c.1920)\n\n\nGet two dimensional array\n********************************************************************************\n\nInstead, what if you have to use `pyexcel.get_array` to do the same:\n\n.. code-block:: python\n\n >>> for row in p.get_array(file_name=\"your_file.xls\", start_row=1):\n ... print(f\"{row[2]} are from {row[0]} period ({row[1]})\")\n Machaut, Landini are from Medieval period (c.1150-c.1400)\n Gibbons, Frescobaldi are from Renaissance period (c.1400-c.1600)\n JS Bach, Vivaldi are from Baroque period (c.1600-c.1750)\n Joseph Haydn, Wolfgan Amadeus Mozart are from Classical period (c.1750-c.1830)\n Chopin, Mendelssohn, Schumann, Liszt are from Earley Romantic period (c.1830-c.1860)\n Wagner,Verdi are from Late Romantic period (c.1860-c.1920)\n\n\nwhere `start_row` skips the header row.\n\n\nGet a dictionary\n********************************************************************************\n\nYou can get a dictionary too:\n\nNow let's get a dictionary out from the spreadsheet:\n\n.. code-block:: python\n\n >>> my_dict = p.get_dict(file_name=\"your_file.xls\", name_columns_by_row=0)\n\nAnd check what do we have:\n\n.. code-block:: python\n\n >>> from pyexcel._compact import OrderedDict\n >>> isinstance(my_dict, OrderedDict)\n True\n >>> for key, values in my_dict.items():\n ... print(key + \" : \" + ','.join([str(item) for item in values]))\n Name : Medieval,Renaissance,Baroque,Classical,Earley Romantic,Late Romantic\n Period : c.1150-c.1400,c.1400-c.1600,c.1600-c.1750,c.1750-c.1830,c.1830-c.1860,c.1860-c.1920\n Representative Composers : Machaut, Landini,Gibbons, Frescobaldi,JS Bach, Vivaldi,Joseph Haydn, Wolfgan Amadeus Mozart,Chopin, Mendelssohn, Schumann, Liszt,Wagner,Verdi\n\n\nPlease note that my_dict is an OrderedDict.\n\nGet a dictionary of two dimensional array\n********************************************************************************\n\n\nSuppose you have a multiple sheet book as the following:\n\n\npyexcel:Sheet 1:\n\n===================== = =\n1 2 3\n4 5 6\n7 8 9\n===================== = =\n\npyexcel:Sheet 2:\n\n===================== = =\nX Y Z\n1 2 3\n4 5 6\n===================== = =\n\npyexcel:Sheet 3:\n\n===================== = =\nO P Q\n3 2 1\n4 3 2\n===================== = =\n\n\nHere is the code to obtain those sheets as a single dictionary:\n\n.. code-block:: python\n\n >>> book_dict = p.get_book_dict(file_name=\"book.xls\")\n\nAnd check:\n\n.. code-block:: python\n\n >>> isinstance(book_dict, OrderedDict)\n True\n >>> import json\n >>> for key, item in book_dict.items():\n ... print(json.dumps({key: item}))\n {\"Sheet 1\": [[1, 2, 3], [4, 5, 6], [7, 8, 9]]}\n {\"Sheet 2\": [[\"X\", \"Y\", \"Z\"], [1, 2, 3], [4, 5, 6]]}\n {\"Sheet 3\": [[\"O\", \"P\", \"Q\"], [3, 2, 1], [4, 3, 2]]}\n\n\nWrite data\n---------------------------------------------\n\nExport an array\n**********************\n\nSuppose you have the following array:\n\n.. code-block:: python\n\n >>> data = [[1, 2, 3], [4, 5, 6], [7, 8, 9]]\n\nAnd here is the code to save it as an excel file :\n\n.. code-block:: python\n\n >>> p.save_as(array=data, dest_file_name=\"example.xls\")\n\nLet's verify it:\n\n.. code-block:: python\n\n >>> p.get_sheet(file_name=\"example.xls\")\n pyexcel_sheet1:\n +---+---+---+\n | 1 | 2 | 3 |\n +---+---+---+\n | 4 | 5 | 6 |\n +---+---+---+\n | 7 | 8 | 9 |\n +---+---+---+\n\n\nAnd here is the code to save it as a csv file :\n\n.. code-block:: python\n\n >>> p.save_as(array=data,\n ... dest_file_name=\"example.csv\",\n ... dest_delimiter=':')\n\nLet's verify it:\n\n.. code-block:: python\n\n >>> with open(\"example.csv\") as f:\n ... for line in f.readlines():\n ... print(line.rstrip())\n ...\n 1:2:3\n 4:5:6\n 7:8:9\n\nExport a list of dictionaries\n**********************************\n\n.. code-block:: python\n\n >>> records = [\n ... {\"year\": 1903, \"country\": \"Germany\", \"speed\": \"206.7km/h\"},\n ... {\"year\": 1964, \"country\": \"Japan\", \"speed\": \"210km/h\"},\n ... {\"year\": 2008, \"country\": \"China\", \"speed\": \"350km/h\"}\n ... ]\n >>> p.save_as(records=records, dest_file_name='high_speed_rail.xls')\n\n\nExport a dictionary of single key value pair\n********************************************************************************\n\n.. code-block:: python\n\n >>> henley_on_thames_facts = {\n ... \"area\": \"5.58 square meters\",\n ... \"population\": \"11,619\",\n ... \"civial parish\": \"Henley-on-Thames\",\n ... \"latitude\": \"51.536\",\n ... \"longitude\": \"-0.898\"\n ... }\n >>> p.save_as(adict=henley_on_thames_facts, dest_file_name='henley.xlsx')\n\n\nExport a dictionary of single dimensonal array\n********************************************************************************\n\n.. code-block:: python\n\n >>> ccs_insights = {\n ... \"year\": [\"2017\", \"2018\", \"2019\", \"2020\", \"2021\"],\n ... \"smart phones\": [1.53, 1.64, 1.74, 1.82, 1.90],\n ... \"feature phones\": [0.46, 0.38, 0.30, 0.23, 0.17]\n ... }\n >>> p.save_as(adict=ccs_insights, dest_file_name='ccs.csv')\n\n\nExport a dictionary of two dimensional array as a book\n********************************************************************************\n\nSuppose you want to save the below dictionary to an excel file :\n\n.. code-block:: python\n\n >>> a_dictionary_of_two_dimensional_arrays = {\n ... 'Sheet 1':\n ... [\n ... [1.0, 2.0, 3.0],\n ... [4.0, 5.0, 6.0],\n ... [7.0, 8.0, 9.0]\n ... ],\n ... 'Sheet 2':\n ... [\n ... ['X', 'Y', 'Z'],\n ... [1.0, 2.0, 3.0],\n ... [4.0, 5.0, 6.0]\n ... ],\n ... 'Sheet 3':\n ... [\n ... ['O', 'P', 'Q'],\n ... [3.0, 2.0, 1.0],\n ... [4.0, 3.0, 2.0]\n ... ]\n ... }\n\nHere is the code:\n\n.. code-block:: python\n\n >>> p.save_book_as(\n ... bookdict=a_dictionary_of_two_dimensional_arrays,\n ... dest_file_name=\"book.xls\"\n ... )\n\nIf you want to preserve the order of sheets in your dictionary, you have to\npass on an ordered dictionary to the function itself. For example:\n\n.. code-block:: python\n\n >>> data = OrderedDict()\n >>> data.update({\"Sheet 2\": a_dictionary_of_two_dimensional_arrays['Sheet 2']})\n >>> data.update({\"Sheet 1\": a_dictionary_of_two_dimensional_arrays['Sheet 1']})\n >>> data.update({\"Sheet 3\": a_dictionary_of_two_dimensional_arrays['Sheet 3']})\n >>> p.save_book_as(bookdict=data, dest_file_name=\"book.xls\")\n\nLet's verify its order:\n\n.. code-block:: python\n\n >>> book_dict = p.get_book_dict(file_name=\"book.xls\")\n >>> for key, item in book_dict.items():\n ... print(json.dumps({key: item}))\n {\"Sheet 2\": [[\"X\", \"Y\", \"Z\"], [1, 2, 3], [4, 5, 6]]}\n {\"Sheet 1\": [[1, 2, 3], [4, 5, 6], [7, 8, 9]]}\n {\"Sheet 3\": [[\"O\", \"P\", \"Q\"], [3, 2, 1], [4, 3, 2]]}\n\nPlease notice that \"Sheet 2\" is the first item in the *book_dict*, meaning the order of sheets are preserved.\n\n\nTranscoding\n-------------------------------------------\n\n.. note::\n\n Please note that `pyexcel-cli` can perform file transcoding at command line.\n No need to open your editor, save the problem, then python run.\n\n\nThe following code does a simple file format transcoding from xls to csv:\n\n.. code-block:: python\n\n >>> p.save_as(file_name=\"birth.xls\", dest_file_name=\"birth.csv\")\n\nAgain it is really simple. Let's verify what we have gotten:\n\n.. code-block:: python\n\n >>> sheet = p.get_sheet(file_name=\"birth.csv\")\n >>> sheet\n birth.csv:\n +-------+--------+----------+\n | name | weight | birth |\n +-------+--------+----------+\n | Adam | 3.4 | 03/02/15 |\n +-------+--------+----------+\n | Smith | 4.2 | 12/11/14 |\n +-------+--------+----------+\n\n.. NOTE::\n\n Please note that csv(comma separate value) file is pure text file. Formula, charts, images and formatting in xls file will disappear no matter which transcoding tool you use. Hence, pyexcel is a quick alternative for this transcoding job.\n\n\nLet use previous example and save it as xlsx instead\n\n.. code-block:: python\n\n >>> p.save_as(file_name=\"birth.xls\",\n ... dest_file_name=\"birth.xlsx\") # change the file extension\n\nAgain let's verify what we have gotten:\n\n.. code-block:: python\n\n >>> sheet = p.get_sheet(file_name=\"birth.xlsx\")\n >>> sheet\n pyexcel_sheet1:\n +-------+--------+----------+\n | name | weight | birth |\n +-------+--------+----------+\n | Adam | 3.4 | 03/02/15 |\n +-------+--------+----------+\n | Smith | 4.2 | 12/11/14 |\n +-------+--------+----------+\n\n\nExcel book merge and split operation in one line\n--------------------------------------------------------------------------------\n\nMerge all excel files in directory into a book where each file become a sheet\n********************************************************************************\n\nThe following code will merge every excel files into one file, say \"output.xls\":\n\n.. code-block:: python\n\n from pyexcel.cookbook import merge_all_to_a_book\n import glob\n\n\n merge_all_to_a_book(glob.glob(\"your_csv_directory\\*.csv\"), \"output.xls\")\n\nYou can mix and match with other excel formats: xls, xlsm and ods. For example, if you are sure you have only xls, xlsm, xlsx, ods and csv files in `your_excel_file_directory`, you can do the following:\n\n.. code-block:: python\n\n from pyexcel.cookbook import merge_all_to_a_book\n import glob\n\n\n merge_all_to_a_book(glob.glob(\"your_excel_file_directory\\*.*\"), \"output.xls\")\n\nSplit a book into single sheet files\n****************************************\n\n\nSuppose you have many sheets in a work book and you would like to separate each into a single sheet excel file. You can easily do this:\n\n.. code-block:: python\n\n >>> from pyexcel.cookbook import split_a_book\n >>> split_a_book(\"megabook.xls\", \"output.xls\")\n >>> import glob\n >>> outputfiles = glob.glob(\"*_output.xls\")\n >>> for file in sorted(outputfiles):\n ... print(file)\n ...\n Sheet 1_output.xls\n Sheet 2_output.xls\n Sheet 3_output.xls\n\nfor the output file, you can specify any of the supported formats\n\n\nExtract just one sheet from a book\n*************************************\n\n\nSuppose you just want to extract one sheet from many sheets that exists in a work book and you would like to separate it into a single sheet excel file. You can easily do this:\n\n.. code-block:: python\n\n >>> from pyexcel.cookbook import extract_a_sheet_from_a_book\n >>> extract_a_sheet_from_a_book(\"megabook.xls\", \"Sheet 1\", \"output.xls\")\n >>> if os.path.exists(\"Sheet 1_output.xls\"):\n ... print(\"Sheet 1_output.xls exists\")\n ...\n Sheet 1_output.xls exists\n\nfor the output file, you can specify any of the supported formats\n\n\nHidden feature: partial read\n===============================================\n\nMost pyexcel users do not know, but other library users were requesting `partial read <https://github.com/jazzband/tablib/issues/467>`_\n\n\nWhen you are dealing with huge amount of data, e.g. 64GB, obviously you would not\nlike to fill up your memory with those data. What you may want to do is, record\ndata from Nth line, take M records and stop. And you only want to use your memory\nfor the M records, not for beginning part nor for the tail part.\n\nHence partial read feature is developed to read partial data into memory for\nprocessing. \n\nYou can paginate by row, by column and by both, hence you dictate what portion of the\ndata to read back. But remember only row limit features help you save memory. Let's\nyou use this feature to record data from Nth column, take M number of columns and skip\nthe rest. You are not going to reduce your memory footprint.\n\nWhy did not I see above benefit?\n--------------------------------------------------------------------------------\n\nThis feature depends heavily on the implementation details.\n\n`pyexcel-xls`_ (xlrd), `pyexcel-xlsx`_ (openpyxl), `pyexcel-ods`_ (odfpy) and\n`pyexcel-ods3`_ (pyexcel-ezodf) will read all data into memory. Because xls,\nxlsx and ods file are effective a zipped folder, all four will unzip the folder\nand read the content in xml format in **full**, so as to make sense of all details.\n\nHence, during the partial data is been returned, the memory consumption won't\ndiffer from reading the whole data back. Only after the partial\ndata is returned, the memory comsumption curve shall jump the cliff. So pagination\ncode here only limits the data returned to your program.\n\nWith that said, `pyexcel-xlsxr`_, `pyexcel-odsr`_ and `pyexcel-htmlr`_ DOES read\npartial data into memory. Those three are implemented in such a way that they\nconsume the xml(html) when needed. When they have read designated portion of the\ndata, they stop, even if they are half way through.\n\nIn addition, pyexcel's csv readers can read partial data into memory too.\n\n\nLet's assume the following file is a huge csv file:\n\n.. code-block:: python\n\n >>> import datetime\n >>> import pyexcel as pe\n >>> 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 >>> pe.save_as(array=data, dest_file_name=\"your_file.csv\")\n\n\nAnd let's pretend to read partial data:\n\n\n.. code-block:: python\n\n >>> pe.get_sheet(file_name=\"your_file.csv\", start_row=2, row_limit=3)\n your_file.csv:\n +---+----+----+\n | 3 | 23 | 33 |\n +---+----+----+\n | 4 | 24 | 34 |\n +---+----+----+\n | 5 | 25 | 35 |\n +---+----+----+\n\nAnd you could as well do the same for columns:\n\n.. code-block:: python\n\n >>> pe.get_sheet(file_name=\"your_file.csv\", start_column=1, column_limit=2)\n your_file.csv:\n +----+----+\n | 21 | 31 |\n +----+----+\n | 22 | 32 |\n +----+----+\n | 23 | 33 |\n +----+----+\n | 24 | 34 |\n +----+----+\n | 25 | 35 |\n +----+----+\n | 26 | 36 |\n +----+----+\n\nObvious, you could do both at the same time:\n\n.. code-block:: python\n\n >>> pe.get_sheet(file_name=\"your_file.csv\",\n ... start_row=2, row_limit=3,\n ... start_column=1, column_limit=2)\n your_file.csv:\n +----+----+\n | 23 | 33 |\n +----+----+\n | 24 | 34 |\n +----+----+\n | 25 | 35 |\n +----+----+\n\n\nThe pagination support is available across all pyexcel plugins.\n\n.. note::\n\n No column pagination support for query sets as data source. \n\n\nFormatting while transcoding a big data file\n--------------------------------------------------------------------------------\n\nIf you are transcoding a big data set, conventional formatting method would not\nhelp unless a on-demand free RAM is available. However, there is a way to minimize\nthe memory footprint of pyexcel while the formatting is performed.\n\nLet's continue from previous example. Suppose we want to transcode \"your_file.csv\"\nto \"your_file.xls\" but increase each element by 1.\n\nWhat we can do is to define a row renderer function as the following:\n\n.. code-block:: python\n\n >>> def increment_by_one(row):\n ... for element in row:\n ... yield element + 1\n\nThen pass it onto save_as function using row_renderer:\n\n.. code-block:: python\n\n >>> pe.isave_as(file_name=\"your_file.csv\",\n ... row_renderer=increment_by_one,\n ... dest_file_name=\"your_file.xlsx\")\n\n\n.. note::\n\n If the data content is from a generator, isave_as has to be used.\n \nWe can verify if it was done correctly:\n\n.. code-block:: python\n\n >>> pe.get_sheet(file_name=\"your_file.xlsx\")\n your_file.csv:\n +---+----+----+\n | 2 | 22 | 32 |\n +---+----+----+\n | 3 | 23 | 33 |\n +---+----+----+\n | 4 | 24 | 34 |\n +---+----+----+\n | 5 | 25 | 35 |\n +---+----+----+\n | 6 | 26 | 36 |\n +---+----+----+\n | 7 | 27 | 37 |\n +---+----+----+\n\n\nStream APIs for big file : A set of two liners\n================================================================================\n\nWhen you are dealing with **BIG** excel files, you will want **pyexcel** to use\nconstant memory.\n\nThis section shows you how to get data from your **BIG** excel files and how to\nexport data to excel files in **two lines** at most, without eating all\nyour computer memory.\n\n\nTwo liners for get data from big excel files\n--------------------------------------------------------------------------------\n\nGet a list of dictionaries\n********************************************************************************\n\n\n\nSuppose you want to process the following coffee data again:\n\nTop 5 coffeine drinks:\n\n===================================== =============== =============\nCoffees Serving Size Caffeine (mg)\nStarbucks Coffee Blonde Roast venti(20 oz) 475\nDunkin' Donuts Coffee with Turbo Shot large(20 oz.) 398\nStarbucks Coffee Pike Place Roast grande(16 oz.) 310\nPanera Coffee Light Roast regular(16 oz.) 300\n===================================== =============== =============\n\n\nLet's get a list of dictionary out from the xls file:\n\n.. code-block:: python\n\n >>> records = p.iget_records(file_name=\"your_file.xls\")\n\nAnd let's check what do we have:\n\n.. code-block:: python\n\n >>> for r in records:\n ... print(f\"{r['Serving Size']} of {r['Coffees']} has {r['Caffeine (mg)']} mg\")\n venti(20 oz) of Starbucks Coffee Blonde Roast has 475 mg\n large(20 oz.) of Dunkin' Donuts Coffee with Turbo Shot has 398 mg\n grande(16 oz.) of Starbucks Coffee Pike Place Roast has 310 mg\n regular(16 oz.) of Panera Coffee Light Roast has 300 mg\n\nPlease do not forgot the second line to close the opened file handle:\n\n.. code-block:: python\n\n >>> p.free_resources()\n\nGet two dimensional array\n********************************************************************************\n\nInstead, what if you have to use `pyexcel.get_array` to do the same:\n\n.. code-block:: python\n\n >>> for row in p.iget_array(file_name=\"your_file.xls\", start_row=1):\n ... print(f\"{row[1]} of {row[0]} has {row[2]} mg\")\n venti(20 oz) of Starbucks Coffee Blonde Roast has 475 mg\n large(20 oz.) of Dunkin' Donuts Coffee with Turbo Shot has 398 mg\n grande(16 oz.) of Starbucks Coffee Pike Place Roast has 310 mg\n regular(16 oz.) of Panera Coffee Light Roast has 300 mg\n\nAgain, do not forgot the second line:\n\n.. code-block:: python\n\n >>> p.free_resources()\n\nwhere `start_row` skips the header row.\n\nData export in one liners\n---------------------------------------------\n\nExport an array\n**********************\n\nSuppose you have the following array:\n\n.. code-block:: python\n\n >>> data = [[1, 2, 3], [4, 5, 6], [7, 8, 9]]\n\nAnd here is the code to save it as an excel file :\n\n.. code-block:: python\n\n >>> p.isave_as(array=data, dest_file_name=\"example.xls\")\n\nBut the following line is not required because the data source\nare not file sources:\n\n.. code-block:: python\n\n >>> # p.free_resources()\n\nLet's verify it:\n\n.. code-block:: python\n\n >>> p.get_sheet(file_name=\"example.xls\")\n pyexcel_sheet1:\n +---+---+---+\n | 1 | 2 | 3 |\n +---+---+---+\n | 4 | 5 | 6 |\n +---+---+---+\n | 7 | 8 | 9 |\n +---+---+---+\n\n\nAnd here is the code to save it as a csv file :\n\n.. code-block:: python\n\n >>> p.isave_as(array=data,\n ... dest_file_name=\"example.csv\",\n ... dest_delimiter=':')\n\nLet's verify it:\n\n.. code-block:: python\n\n >>> with open(\"example.csv\") as f:\n ... for line in f.readlines():\n ... print(line.rstrip())\n ...\n 1:2:3\n 4:5:6\n 7:8:9\n\nExport a list of dictionaries\n**********************************\n\n.. code-block:: python\n\n >>> records = [\n ... {\"year\": 1903, \"country\": \"Germany\", \"speed\": \"206.7km/h\"},\n ... {\"year\": 1964, \"country\": \"Japan\", \"speed\": \"210km/h\"},\n ... {\"year\": 2008, \"country\": \"China\", \"speed\": \"350km/h\"}\n ... ]\n >>> p.isave_as(records=records, dest_file_name='high_speed_rail.xls')\n\nExport a dictionary of single key value pair\n********************************************************************************\n\n.. code-block:: python\n\n >>> henley_on_thames_facts = {\n ... \"area\": \"5.58 square meters\",\n ... \"population\": \"11,619\",\n ... \"civial parish\": \"Henley-on-Thames\",\n ... \"latitude\": \"51.536\",\n ... \"longitude\": \"-0.898\"\n ... }\n >>> p.isave_as(adict=henley_on_thames_facts, dest_file_name='henley.xlsx')\n\nExport a dictionary of single dimensonal array\n********************************************************************************\n\n.. code-block:: python\n\n >>> ccs_insights = {\n ... \"year\": [\"2017\", \"2018\", \"2019\", \"2020\", \"2021\"],\n ... \"smart phones\": [1.53, 1.64, 1.74, 1.82, 1.90],\n ... \"feature phones\": [0.46, 0.38, 0.30, 0.23, 0.17]\n ... }\n >>> p.isave_as(adict=ccs_insights, dest_file_name='ccs.csv')\n >>> p.free_resources()\n\nExport a dictionary of two dimensional array as a book\n********************************************************************************\n\nSuppose you want to save the below dictionary to an excel file :\n\n.. code-block:: python\n\n >>> a_dictionary_of_two_dimensional_arrays = {\n ... 'Sheet 1':\n ... [\n ... [1.0, 2.0, 3.0],\n ... [4.0, 5.0, 6.0],\n ... [7.0, 8.0, 9.0]\n ... ],\n ... 'Sheet 2':\n ... [\n ... ['X', 'Y', 'Z'],\n ... [1.0, 2.0, 3.0],\n ... [4.0, 5.0, 6.0]\n ... ],\n ... 'Sheet 3':\n ... [\n ... ['O', 'P', 'Q'],\n ... [3.0, 2.0, 1.0],\n ... [4.0, 3.0, 2.0]\n ... ]\n ... }\n\nHere is the code:\n\n.. code-block:: python\n\n >>> p.isave_book_as(\n ... bookdict=a_dictionary_of_two_dimensional_arrays,\n ... dest_file_name=\"book.xls\"\n ... )\n\nIf you want to preserve the order of sheets in your dictionary, you have to\npass on an ordered dictionary to the function itself. For example:\n\n.. code-block:: python\n\n >>> from pyexcel._compact import OrderedDict\n >>> data = OrderedDict()\n >>> data.update({\"Sheet 2\": a_dictionary_of_two_dimensional_arrays['Sheet 2']})\n >>> data.update({\"Sheet 1\": a_dictionary_of_two_dimensional_arrays['Sheet 1']})\n >>> data.update({\"Sheet 3\": a_dictionary_of_two_dimensional_arrays['Sheet 3']})\n >>> p.isave_book_as(bookdict=data, dest_file_name=\"book.xls\")\n >>> p.free_resources()\n\nLet's verify its order:\n\n.. code-block:: python\n\n >>> import json\n >>> book_dict = p.get_book_dict(file_name=\"book.xls\")\n >>> for key, item in book_dict.items():\n ... print(json.dumps({key: item}))\n {\"Sheet 2\": [[\"X\", \"Y\", \"Z\"], [1, 2, 3], [4, 5, 6]]}\n {\"Sheet 1\": [[1, 2, 3], [4, 5, 6], [7, 8, 9]]}\n {\"Sheet 3\": [[\"O\", \"P\", \"Q\"], [3, 2, 1], [4, 3, 2]]}\n\nPlease notice that \"Sheet 2\" is the first item in the *book_dict*, meaning the order of sheets are preserved.\n\n\nFile format transcoding on one line\n-------------------------------------------\n\n.. note::\n\n Please note that the following file transcoding could be with zero line. Please\n install pyexcel-cli and you will do the transcode in one command. No need to\n open your editor, save the problem, then python run.\n\n\nThe following code does a simple file format transcoding from xls to csv:\n\n.. code-block:: python\n\n >>> import pyexcel\n >>> p.save_as(file_name=\"birth.xls\", dest_file_name=\"birth.csv\")\n\nAgain it is really simple. Let's verify what we have gotten:\n\n.. code-block:: python\n\n >>> sheet = p.get_sheet(file_name=\"birth.csv\")\n >>> sheet\n birth.csv:\n +-------+--------+----------+\n | name | weight | birth |\n +-------+--------+----------+\n | Adam | 3.4 | 03/02/15 |\n +-------+--------+----------+\n | Smith | 4.2 | 12/11/14 |\n +-------+--------+----------+\n\n.. note::\n\n Please note that csv(comma separate value) file is pure text file. Formula, charts, images and formatting in xls file will disappear no matter which transcoding tool you use. Hence, pyexcel is a quick alternative for this transcoding job.\n\n\nLet use previous example and save it as xlsx instead\n\n.. code-block:: python\n\n >>> import pyexcel\n >>> p.isave_as(file_name=\"birth.xls\",\n ... dest_file_name=\"birth.xlsx\") # change the file extension\n\nAgain let's verify what we have gotten:\n\n.. code-block:: python\n\n >>> sheet = p.get_sheet(file_name=\"birth.xlsx\")\n >>> sheet\n pyexcel_sheet1:\n +-------+--------+----------+\n | name | weight | birth |\n +-------+--------+----------+\n | Adam | 3.4 | 03/02/15 |\n +-------+--------+----------+\n | Smith | 4.2 | 12/11/14 |\n +-------+--------+----------+\n\n\nAvailable Plugins\n=================\n\n.. _file-format-list:\n.. _a-map-of-plugins-and-file-formats:\n\n.. table:: A list of file formats supported by external plugins\n\n ======================== ======================= =================\n Package name Supported file formats Dependencies\n ======================== ======================= =================\n `pyexcel-io`_ csv, csvz [#f1]_, tsv,\n tsvz [#f2]_\n `pyexcel-xls`_ xls, xlsx(read only), `xlrd`_,\n xlsm(read only) `xlwt`_\n `pyexcel-xlsx`_ xlsx `openpyxl`_\n `pyexcel-ods3`_ ods `pyexcel-ezodf`_,\n lxml\n `pyexcel-ods`_ ods `odfpy`_\n ======================== ======================= =================\n\n.. table:: Dedicated file reader and writers\n\n ======================== ======================= =================\n Package name Supported file formats Dependencies\n ======================== ======================= =================\n `pyexcel-xlsxw`_ xlsx(write only) `XlsxWriter`_\n `pyexcel-libxlsxw`_ xlsx(write only) `libxlsxwriter`_\n `pyexcel-xlsxr`_ xlsx(read only) lxml\n `pyexcel-xlsbr`_ xlsb(read only) pyxlsb\n `pyexcel-odsr`_ read only for ods, fods lxml\n `pyexcel-odsw`_ write only for ods loxun\n `pyexcel-htmlr`_ html(read only) lxml,html5lib\n `pyexcel-pdfr`_ pdf(read only) camelot\n ======================== ======================= =================\n\n\nPlugin shopping guide\n------------------------\n\nSince 2020, all pyexcel-io plugins have dropped the support for python versions\nwhich are lower than 3.6. If you want to use any of those Python versions, please use pyexcel-io\nand its plugins versions that are lower than 0.6.0.\n\n\nExcept csv files, xls, xlsx and ods files are a zip of a folder containing a lot of\nxml files\n\nThe dedicated readers for excel files can stream read\n\n\nIn order to manage the list of plugins installed, you need to use pip to add or remove\na plugin. When you use virtualenv, you can have different plugins per virtual\nenvironment. In the situation where you have multiple plugins that does the same thing\nin your environment, you need to tell pyexcel which plugin to use per function call.\nFor example, pyexcel-ods and pyexcel-odsr, and you want to get_array to use pyexcel-odsr.\nYou need to append get_array(..., library='pyexcel-odsr').\n\n\n\n.. _pyexcel-io: https://github.com/pyexcel/pyexcel-io\n.. _pyexcel-xls: https://github.com/pyexcel/pyexcel-xls\n.. _pyexcel-xlsx: https://github.com/pyexcel/pyexcel-xlsx\n.. _pyexcel-ods: https://github.com/pyexcel/pyexcel-ods\n.. _pyexcel-ods3: https://github.com/pyexcel/pyexcel-ods3\n.. _pyexcel-odsr: https://github.com/pyexcel/pyexcel-odsr\n.. _pyexcel-odsw: https://github.com/pyexcel/pyexcel-odsw\n.. _pyexcel-pdfr: https://github.com/pyexcel/pyexcel-pdfr\n\n.. _pyexcel-xlsxw: https://github.com/pyexcel/pyexcel-xlsxw\n.. _pyexcel-libxlsxw: https://github.com/pyexcel/pyexcel-libxlsxw\n.. _pyexcel-xlsxr: https://github.com/pyexcel/pyexcel-xlsxr\n.. _pyexcel-xlsbr: https://github.com/pyexcel/pyexcel-xlsbr\n.. _pyexcel-htmlr: https://github.com/pyexcel/pyexcel-htmlr\n\n.. _xlrd: https://github.com/python-excel/xlrd\n.. _xlwt: https://github.com/python-excel/xlwt\n.. _openpyxl: https://bitbucket.org/openpyxl/openpyxl\n.. _XlsxWriter: https://github.com/jmcnamara/XlsxWriter\n.. _pyexcel-ezodf: https://github.com/pyexcel/pyexcel-ezodf\n.. _odfpy: https://github.com/eea/odfpy\n.. _libxlsxwriter: http://libxlsxwriter.github.io/getting_started.html\n\n.. table:: Other data renderers\n\n ======================== ======================= ================= ==================\n Package name Supported file formats Dependencies Python versions\n ======================== ======================= ================= ==================\n `pyexcel-text`_ write only:rst, `tabulate`_ 2.6, 2.7, 3.3, 3.4\n mediawiki, html, 3.5, 3.6, pypy\n latex, grid, pipe,\n orgtbl, plain simple\n read only: ndjson\n r/w: json\n `pyexcel-handsontable`_ handsontable in html `handsontable`_ same as above\n `pyexcel-pygal`_ svg chart `pygal`_ 2.7, 3.3, 3.4, 3.5\n 3.6, pypy\n `pyexcel-sortable`_ sortable table in html `csvtotable`_ same as above\n `pyexcel-gantt`_ gantt chart in html `frappe-gantt`_ except pypy, same\n as above\n ======================== ======================= ================= ==================\n\n.. _pyexcel-text: https://github.com/pyexcel/pyexcel-text\n.. _tabulate: https://bitbucket.org/astanin/python-tabulate\n.. _pyexcel-handsontable: https://github.com/pyexcel/pyexcel-handsontable\n.. _handsontable: https://cdnjs.com/libraries/handsontable\n.. _pyexcel-pygal: https://github.com/pyexcel/pyexcel-chart\n.. _pygal: https://github.com/Kozea/pygal\n.. _pyexcel-matplotlib: https://github.com/pyexcel/pyexcel-matplotlib\n.. _matplotlib: https://matplotlib.org\n.. _pyexcel-sortable: https://github.com/pyexcel/pyexcel-sortable\n.. _csvtotable: https://github.com/vividvilla/csvtotable\n.. _pyexcel-gantt: https://github.com/pyexcel/pyexcel-gantt\n.. _frappe-gantt: https://github.com/frappe/gantt\n\n.. rubric:: Footnotes\n\n.. [#f1] zipped csv file\n.. [#f2] zipped tsv file\n\n\nAcknowledgement\n===============\n\nAll great work have been done by odf, ezodf, xlrd, xlwt, tabulate and other\nindividual developers. This library unites only the data access code.\n\n\n\n\nLicense\n================================================================================\n\nNew BSD License\n\n\n\n19 contributors\n================================================================================\n\nIn alphabetical order:\n\n* `Akshaya Kumar Sharma <https://github.com/akshayakrsh>`_\n* `Andre Almar <https://github.com/andrealmar>`_\n* `Arunkumar Rajendran <https://github.com/arunkumar-ra>`_\n* `Ayan Banerjee <https://github.com/ayan-b>`_\n* `Chris Hill-Scott <https://github.com/quis>`_\n* `Craig Anderson <https://github.com/craiga>`_\n* `Daryl Yu <https://github.com/darylyu>`_\n* `J Harley <https://github.com/julzhk>`_\n* `Joel Nothman <https://github.com/jnothman>`_\n* `John Vandenberg <https://github.com/jayvdb>`_\n* `Linghui Zeng <https://github.com/mathsyouth>`_\n* `Nik Nyby <https://github.com/nikolas>`_\n* `Rintze M. Zelle, PhD <https://github.com/rmzelle>`_\n* `Simeon Visser <https://github.com/svisser>`_\n* `Simon Allen <https://github.com/garfunkel>`_\n* `simon klemenc <https://github.com/hiaselhans>`_\n* `Tim Gates <https://github.com/timgates42>`_\n* `Wesley A. Cheng <https://github.com/wesleyacheng>`_\n* `William Jamir Silva <https://github.com/williamjamir>`_\n\nChange log\n================================================================================\n\n0.7.0 - 12.2.2022\n--------------------------------------------------------------------------------\n\n**Fixed**\n\n#. `#250 <https://github.com/pyexcel/pyexcel/issues/250>`_: RecursionError\n raised on deepcopy of a sheet\n\n**Updated**\n\n#. `#255 <https://github.com/pyexcel/pyexcel/issues/255>`_: pyexcel.get_array\n documentation page seems to be a copy of pyexcel.get_sheet\n\n**Removed**\n\n#. `#249 <https://github.com/pyexcel/pyexcel/issues/249>`_: drop the support for\n dummy import statements pyexcel.ext.*\n\n0.6.7 - 12.09.2021\n--------------------------------------------------------------------------------\n\n**Updated**\n\n#. `#243 <https://github.com/pyexcel/pyexcel/issues/243>`_: fix small typo.\n#. add chardet as explicit dependency\n\n0.6.6 - 14.11.2020\n--------------------------------------------------------------------------------\n\n**Updated**\n\n#. `#233 <https://github.com/pyexcel/pyexcel/issues/233>`_: dynamically resize\n the table matrix on set_value. sheet['AA1'] = 'test' will work in this\n release.\n\n0.6.5 - 8.10.2020\n--------------------------------------------------------------------------------\n\n**Updated**\n\n#. update queryset source to work with pyexcel-io 0.6.0\n\n0.6.4 - 18.08.2020\n--------------------------------------------------------------------------------\n\n**Updated**\n\n#. `#219 <https://github.com/pyexcel/pyexcel/issues/219>`_: book created from\n dict no longer discards order.\n\n0.6.3 - 01.08.2020\n--------------------------------------------------------------------------------\n\n**fixed**\n\n#. `#214 <https://github.com/pyexcel/pyexcel/issues/214>`_: remove leading and\n trailing whitespace for column names\n\n**removed**\n\n#. python 2 compatibility have been permanently removed.\n\n0.6.2 - 8.06.2020\n--------------------------------------------------------------------------------\n\n**fixed**\n\n#. `#109 <https://github.com/pyexcel/pyexcel/issues/109>`_: Control the column\n order when write the data output\n\n0.6.1 - 02.05.2020\n--------------------------------------------------------------------------------\n\n**fixed**\n\n#. `#203 <https://github.com/pyexcel/pyexcel/issues/203>`_: texttable was\n dropped out in 0.6.0 as compulsary dependency. end user may experience it\n when a sheet/table is printed in a shell. otherwise, new user of pyexcel\n won't see it. As of release date, no issues were created\n\n0.6.0 - 21.04.2020\n--------------------------------------------------------------------------------\n\n**updated**\n\n#. `#199 <https://github.com/pyexcel/pyexcel/issues/199>`_: += in place; = +\n shall return new instance\n#. `#195 <https://github.com/pyexcel/pyexcel/issues/195>`_: documentation\n update. however small is welcome\n\n**removed**\n\n#. Dropping the test support for python version lower than 3.6. v0.6.0 should\n work with python 2.7 but is not guaranteed to work. Please upgrade to python\n 3.6+.\n\n0.5.15 - 07.07.2019\n--------------------------------------------------------------------------------\n\n**updated**\n\n#. `#185 <https://github.com/pyexcel/pyexcel/issues/185>`_: fix a bug with http\n data source. The real fix lies in pyexcel-io v0.5.19. this release just put\n the version requirement in.\n\n0.5.14 - 12.06.2019\n--------------------------------------------------------------------------------\n\n**updated**\n\n#. `#182 <https://github.com/pyexcel/pyexcel/issues/182>`_: support\n dest_force_file_type on save_as and save_book_as\n\n0.5.13 - 12.03.2019\n--------------------------------------------------------------------------------\n\n**updated**\n\n#. `#176 <https://github.com/pyexcel/pyexcel/issues/176>`_: get_sheet\n {IndexError}list index out of range // XLSX can't be opened\n\n0.5.12 - 25.02.2019\n--------------------------------------------------------------------------------\n\n**updated**\n\n#. `#174 <https://github.com/pyexcel/pyexcel/issues/174>`_: include examples in\n tarbar\n\n0.5.11 - 22.02.2019\n--------------------------------------------------------------------------------\n\n**updated**\n\n#. `#169 <https://github.com/pyexcel/pyexcel/issues/169>`_: remove\n pyexcel-handsontalbe in test\n#. add tests, and docs folder in distribution\n\n0.5.10 - 3.12.2018\n--------------------------------------------------------------------------------\n\n**updated**\n\n#. `#157 <https://github.com/pyexcel/pyexcel/issues/157>`_: Please use\n scan_plugins_regex, which lml 0.7 complains about\n#. updated dependency on pyexcel-io to 0.5.11\n\n0.5.9.1 - 30.08.2018\n--------------------------------------------------------------------------------\n\n**updated**\n\n#. to require pyexcel-io 0.5.9.1 and use lml at least version 0.0.2\n\n0.5.9 - 30.08.2018\n--------------------------------------------------------------------------------\n\n**added**\n\n#. support __len__. len(book) returns the number of sheets and len(sheet)\n returns the number of rows\n#. `#144 <https://github.com/pyexcel/pyexcel/issues/144>`_: memory-efficient way\n to read sheet names.\n#. `#148 <https://github.com/pyexcel/pyexcel/issues/148>`_: force_file_type is\n introduced. When reading a file on a disk, this parameter allows you to\n choose a reader. i.e. csv reader for a text file. xlsx reader for a xlsx file\n but with .blob file suffix.\n#. finally, pyexcel got import pyexcel.__version__\n\n**updated**\n\n#. Sheet.to_records() returns a generator now, saving memory\n#. `#115 <https://github.com/pyexcel/pyexcel/issues/115>`_, Fix set membership\n test to run faster in python2\n#. `#140 <https://github.com/pyexcel/pyexcel/issues/140>`_, Direct writes to\n cells yield weird results\n\n0.5.8 - 26.03.2018\n--------------------------------------------------------------------------------\n\n**added**\n\n#. `#125 <https://github.com/pyexcel/pyexcel/issues/125>`_, sort book sheets\n\n**updated**\n\n#. `#126 <https://github.com/pyexcel/pyexcel/issues/126>`_, dest_sheet_name in\n save_as will set the sheet name in the output\n#. `#115 <https://github.com/pyexcel/pyexcel/issues/115>`_, Fix set membership\n test to run faster in python2\n\n0.5.7 - 11.01.2018\n--------------------------------------------------------------------------------\n\n**added**\n\n#. `pyexcel-io#46 <https://github.com/pyexcel/pyexcel-io/issues/46>`_, expose\n `bulk_save` to developer.\n\n0.5.6 - 23.10.2017\n--------------------------------------------------------------------------------\n\n**removed**\n\n#. `#105 <https://github.com/pyexcel/pyexcel/issues/105>`_, remove gease from\n setup_requires, introduced by 0.5.5.\n#. removed testing against python 2.6\n#. `#103 <https://github.com/pyexcel/pyexcel/issues/103>`_, include LICENSE file\n in MANIFEST.in, meaning LICENSE file will appear in the released tar ball.\n\n0.5.5 - 20.10.2017\n--------------------------------------------------------------------------------\n\n**removed**\n\n#. `#105 <https://github.com/pyexcel/pyexcel/issues/105>`_, remove gease from\n setup_requires, introduced by 0.5.5.\n#. removed testing against python 2.6\n#. `#103 <https://github.com/pyexcel/pyexcel/issues/103>`_, include LICENSE file\n in MANIFEST.in, meaning LICENSE file will appear in the released tar ball.\n\n0.5.4 - 27.09.2017\n--------------------------------------------------------------------------------\n\n**fixed**\n\n#. `#100 <https://github.com/pyexcel/pyexcel/issues/100>`_, Sheet.to_dict() gets\n out of range error because there is only one row.\n\n**updated**\n\n#. Updated the baseline of pyexcel-io to 0.5.1.\n\n0.5.3 - 01-08-2017\n--------------------------------------------------------------------------------\n\n**added**\n\n#. `#95 <https://github.com/pyexcel/pyexcel/issues/95>`_, respect the order of\n records in iget_records, isave_as and save_as.\n#. `#97 <https://github.com/pyexcel/pyexcel/issues/97>`_, new feature to allow\n intuitive initialization of pyexcel.Book.\n\n0.5.2 - 26-07-2017\n--------------------------------------------------------------------------------\n\n**Updated**\n\n#. embeded the enabler for pyexcel-htmlr. http source does not support text/html\n as mime type.\n\n0.5.1 - 12.06.2017\n--------------------------------------------------------------------------------\n\n**Updated**\n\n#. support saving SheetStream and BookStream to database targets. This is needed\n for pyexcel-webio and its downstream projects.\n\n0.5.0 - 19.06.2017\n--------------------------------------------------------------------------------\n\n**Added**\n\n#. Sheet.top() and Sheet.top_left() for data browsing\n#. add html as default rich display in Jupyter notebook when pyexcel-text and\n pyexcel-chart is installed\n#. add svg as default rich display in Jupyter notebook when pyexcel-chart and\n one of its implementation plugin(pyexcel-pygal, etc.) are is installed\n#. new dictionary source supported: a dictionary of key value pair could be read\n into a sheet.\n#. added dynamic external plugin loading. meaning if a pyexcel plugin is\n installed, it will be loaded implicitly. And this change would remove\n unnecessary info log for those who do not use pyexcel-text and pyexcel-gal\n#. save_book_as before 0.5.0 becomes isave_book_as and save_book_as in 0.5.0\n convert BookStream to Book before saving.\n#. `#83 <https://github.com/pyexcel/pyexcel/issues/83>`_, file closing mechanism\n is enfored. free_resource is added and it should be called when iget_array,\n iget_records, isave_as and/or isave_book_as are used.\n\n**Updated**\n\n#. array is passed to pyexcel.Sheet as reference. it means your array data will\n be modified.\n\n**Removed**\n\n#. pyexcel.Writer and pyexcel.BookWriter were removed\n#. pyexcel.load_book_from_sql and pyexcel.load_from_sql were removed\n#. pyexcel.deprecated.load_from_query_sets,\n pyexcel.deprecated.load_book_from_django_models and\n pyexcel.deprecated.load_from_django_model were removed\n#. Removed plugin loading code and lml is used instead\n\n0.4.5 - 17.03.2017\n--------------------------------------------------------------------------------\n\n**Updated**\n\n#. `#80 <https://github.com/pyexcel/pyexcel/issues/80>`_: remove pyexcel-chart\n import from v0.4.x\n\n0.4.4 - 06.02.2017\n--------------------------------------------------------------------------------\n\n**Updated**\n\n#. `#68 <https://github.com/pyexcel/pyexcel/issues/68>`_: regression\n save_to_memory() should have returned a stream instance which has been reset\n to zero if possible. The exception is sys.stdout, which cannot be reset.\n#. `#74 <https://github.com/pyexcel/pyexcel/issues/74>`_: Not able to handle\n decimal.Decimal\n\n**Removed**\n\n#. remove get_{{file_type}}_stream functions from pyexcel.Sheet and pyexcel.Book\n introduced since 0.4.3.\n\n0.4.3 - 26.01.2017\n--------------------------------------------------------------------------------\n\n**Added**\n\n#. '.stream' attribute are attached to `~pyexcel.Sheet` and `~pyexcel.Book` to\n get direct access the underneath stream in responding to file type\n attributes, such as sheet.xls. it helps provide a custom stream to external\n world, for example, Sheet.stream.csv gives a text stream that contains csv\n formatted data. Book.stream.xls returns a xls format data in a byte stream.\n\n**Updated**\n\n#. Better error reporting when an unknown parameters or unsupported file types\n were given to the signature functions.\n\n0.4.2 - 17.01.2017\n--------------------------------------------------------------------------------\n\n**Updated**\n\n#. Raise exception if the incoming sheet does not have column names. In other\n words, only sheet with column names could be saved to database. sheet with\n row names cannot be saved. The alternative is to transpose the sheet, then\n name_columns_by_row and then save.\n#. fix iget_records where a non-uniform content should be given, e.g. [[\"x\",\n \"y\"], [1, 2], [3]], some record would become non-uniform, e.g. key 'y' would\n be missing from the second record.\n#. `skip_empty_rows` is applicable when saving a python data structure to\n another data source. For example, if your array contains a row which is\n consisted of empty string, such as ['', '', '' ... ''], please specify\n `skip_empty_rows=False` in order to preserve it. This becomes subtle when you\n try save a python dictionary where empty rows is not easy to be spotted.\n#. `#69 <https://github.com/pyexcel/pyexcel/issues/69>`_: better documentation\n for save_book_as.\n\n0.4.1 - 23.12.2016\n--------------------------------------------------------------------------------\n\n**Updated**\n\n#. `#68 <https://github.com/pyexcel/pyexcel/issues/68>`_: regression\n save_to_memory() should have returned a stream instance.\n\n0.4.0 - 22.12.2016\n--------------------------------------------------------------------------------\n\n**Added**\n\n#. `Flask-Excel#19 <https://github.com/pyexcel/Flask-Excel/issues/19>`_ allow\n sheet_name parameter\n#. `pyexcel-xls#11 <https://github.com/pyexcel/pyexcel-xls/issues/11>`_\n case-insensitive for file_type. `xls` and `XLS` are treated in the same way\n\n**Updated**\n\n#. `#66 <https://github.com/pyexcel/pyexcel/issues/66>`_: `export_columns` is\n ignored\n#. Update dependency on pyexcel-io v0.3.0\n\n0.3.3 - 07.11.2016\n--------------------------------------------------------------------------------\n\n**Updated**\n\n#. `#63 <https://github.com/pyexcel/pyexcel/issues/63>`_: cannot display empty\n sheet(hence book with empty sheet) as texttable\n\n0.3.2 - 02.11.2016\n--------------------------------------------------------------------------------\n\n**Updated**\n\n#. `#62 <https://github.com/pyexcel/pyexcel/issues/62>`_: optional module import\n error become visible.\n\n0.3.0 - 28.10.2016\n--------------------------------------------------------------------------------\n\n**Added:**\n\n#. file type setters for Sheet and Book, and its documentation\n#. `iget_records` returns a generator for a list of records and should have\n better memory performance, especially dealing with large csv files.\n#. `iget_array` returns a generator for a list of two dimensional array and\n should have better memory performance, especially dealing with large csv\n files.\n#. Enable pagination support, and custom row renderer via pyexcel-io v0.2.3\n\n**Updated**\n\n#. Take `isave_as` out from `save_as`. Hence two functions are there for save a\n sheet as\n#. `#60 <https://github.com/pyexcel/pyexcel/issues/60>`_: encode 'utf-8' if the\n console is of ascii encoding.\n#. `#59 <https://github.com/pyexcel/pyexcel/issues/59>`_: custom row renderer\n#. `#56 <https://github.com/pyexcel/pyexcel/issues/56>`_: set cell value does\n not work\n#. pyexcel.transpose becomes `pyexcel.sheets.transpose`\n#. iterator functions of `pyexcel.Sheet` were converted to generator functions\n\n * `pyexcel.Sheet.enumerate()`\n * `pyexcel.Sheet.reverse()`\n * `pyexcel.Sheet.vertical()`\n * `pyexcel.Sheet.rvertical()`\n * `pyexcel.Sheet.rows()`\n * `pyexcel.Sheet.rrows()`\n * `pyexcel.Sheet.columns()`\n * `pyexcel.Sheet.rcolumns()`\n * `pyexcel.Sheet.named_rows()`\n * `pyexcel.Sheet.named_columns()`\n\n#. `~pyexcel.Sheet.save_to_memory` and `~pyexcel.Book.save_to_memory` return the\n actual content. No longer they will return a io object hence you cannot call\n getvalue() on them.\n\n**Removed:**\n\n#. `content` and `out_file` as function parameters to the signature functions\n are no longer supported.\n#. SourceFactory and RendererFactory are removed\n#. The following methods are removed\n\n * `pyexcel.to_array`\n * `pyexcel.to_dict`\n * `pyexcel.utils.to_one_dimensional_array`\n * `pyexcel.dict_to_array`\n * `pyexcel.from_records`\n * `pyexcel.to_records`\n\n#. `pyexcel.Sheet.filter` has been re-implemented and all filters were removed:\n\n * `pyexcel.filters.ColumnIndexFilter`\n * `pyexcel.filters.ColumnFilter`\n * `pyexcel.filters.RowFilter`\n * `pyexcel.filters.EvenColumnFilter`\n * `pyexcel.filters.OddColumnFilter`\n * `pyexcel.filters.EvenRowFilter`\n * `pyexcel.filters.OddRowFilter`\n * `pyexcel.filters.RowIndexFilter`\n * `pyexcel.filters.SingleColumnFilter`\n * `pyexcel.filters.RowValueFilter`\n * `pyexcel.filters.NamedRowValueFilter`\n * `pyexcel.filters.ColumnValueFilter`\n * `pyexcel.filters.NamedColumnValueFilter`\n * `pyexcel.filters.SingleRowFilter`\n\n#. the following functions have been removed\n\n * `add_formatter`\n * `remove_formatter`\n * `clear_formatters`\n * `freeze_formatters`\n * `add_filter`\n * `remove_filter`\n * `clear_filters`\n * `freeze_formatters`\n\n#. `pyexcel.Sheet.filter` has been re-implemented and all filters were removed:\n\n * pyexcel.formatters.SheetFormatter\n\n\n0.2.5 - 31.08.2016\n--------------------------------------------------------------------------------\n\n**Updated:**\n\n#. `#58 <https://github.com/pyexcel/pyexcel/issues/58>`_: texttable should have\n been made as compulsory requirement\n\n0.2.4 - 14.07.2016\n--------------------------------------------------------------------------------\n\n**Updated:**\n\n#. For python 2, writing to sys.stdout by pyexcel-cli raise IOError.\n\n0.2.3 - 11.07.2016\n--------------------------------------------------------------------------------\n\n**Updated:**\n\n#. For python 3, do not seek 0 when saving to memory if sys.stdout is passed on.\n Hence, adding support for sys.stdin and sys.stdout.\n\n0.2.2 - 01.06.2016\n--------------------------------------------------------------------------------\n\n**Updated:**\n\n#. Explicit imports, no longer needed\n#. Depends on latest setuptools 18.0.1\n#. NotImplementedError will be raised if parameters to core functions are not\n supported, e.g. get_sheet(cannot_find_me_option=\"will be thrown out as\n NotImplementedError\")\n\n0.2.1 - 23.04.2016\n--------------------------------------------------------------------------------\n\n**Added:**\n\n#. add pyexcel-text file types as attributes of pyexcel.Sheet and pyexcel.Book,\n related to `#31 <https://github.com/pyexcel/pyexcel/issues/31>`__\n#. auto import pyexcel-text if it is pip installed\n\n**Updated:**\n\n#. code refactoring done for easy addition of sources.\n#. bug fix `#29 <https://github.com/pyexcel/pyexcel/issues/29>`__, Even if the\n format is a string it is displayed as a float\n#. pyexcel-text is no longer a plugin to pyexcel-io but to pyexcel.sources, see\n `pyexcel-text#22 <https://github.com/pyexcel/pyexcel-text/issues/22>`__\n\n**Removed:**\n\n#. pyexcel.presentation is removed. No longer the internal decorate @outsource\n is used. related to `#31 <https://github.com/pyexcel/pyexcel/issues/31>`_\n\n0.2.0 - 17.01.2016\n--------------------------------------------------------------------------------\n\n**Updated**\n\n#. adopt pyexcel-io yield key word to return generator as content\n#. pyexcel.save_as and pyexcel.save_book_as get performance improvements\n\n0.1.7 - 03.07.2015\n--------------------------------------------------------------------------------\n\n**Added**\n\n#. Support pyramid-excel which does the database commit on its own.\n\n0.1.6 - 13.06.2015\n--------------------------------------------------------------------------------\n\n**Added**\n\n#. get excel data from a http url\n\n0.0.13 - 07.02.2015\n--------------------------------------------------------------------------------\n\n**Added**\n\n#. Support django\n#. texttable as default renderer\n\n0.0.12 - 25.01.2015\n--------------------------------------------------------------------------------\n\n**Added**\n\n#. Added sqlalchemy support\n\n0.0.10 - 15.12.2015\n--------------------------------------------------------------------------------\n\n**Added**\n\n#. added csvz and tsvz format\n\n0.0.4 - 12.10.2014\n--------------------------------------------------------------------------------\n\n**Updated**\n\n#. Support python 3\n\n0.0.1 - 14.09.2014\n--------------------------------------------------------------------------------\n\n**Features:**\n\n#. read and write csv, ods, xls, xlsx and xlsm files(which are referred later as\n excel files)\n#. various iterators for the reader\n#. row and column filters for the reader\n#. utilities to get array and dictionary out from excel files.\n#. cookbok receipes for some common and simple usage of this library.\n\n\n\n",
"bugtrack_url": null,
"license": "New BSD",
"summary": "A wrapper library that provides one API to read, manipulate and writedata in different excel formats",
"version": "0.7.0",
"split_keywords": [
"python",
"tsv",
"tsvzcsv",
"csvz",
"xls",
"xlsx",
"ods"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "379a7b8b9955c46ce5699f95a3b9e139",
"sha256": "ddc6904512bfa2ecda509fb3b58229bb30db14498632fd9e7a5ba7bbfb02ed1b"
},
"downloads": -1,
"filename": "pyexcel-0.7.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "379a7b8b9955c46ce5699f95a3b9e139",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.6",
"size": 87660,
"upload_time": "2022-02-12T21:09:11",
"upload_time_iso_8601": "2022-02-12T21:09:11.965330Z",
"url": "https://files.pythonhosted.org/packages/8b/cc/ca982e73be7f817511b11b5c63c8420bf51cb54474d1f3ffab18201c2d3e/pyexcel-0.7.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "fa83e481966ff43a34735ee763c699d3",
"sha256": "fbf0eee5d93b96cef6f19a9f00703f22c0a64f19728d91b95428009a52129709"
},
"downloads": -1,
"filename": "pyexcel-0.7.0.tar.gz",
"has_sig": false,
"md5_digest": "fa83e481966ff43a34735ee763c699d3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 807349,
"upload_time": "2022-02-12T21:09:15",
"upload_time_iso_8601": "2022-02-12T21:09:15.437925Z",
"url": "https://files.pythonhosted.org/packages/70/31/93b6fcabe8c74151952d57df762ee179dca96316232716ec3cdacdaaf0c9/pyexcel-0.7.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-02-12 21:09:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "pyexcel",
"github_project": "pyexcel",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "chardet",
"specs": []
},
{
"name": "lml",
"specs": [
[
">=",
"0.0.4"
]
]
},
{
"name": "pyexcel-io",
"specs": [
[
">=",
"0.6.2"
]
]
},
{
"name": "texttable",
"specs": [
[
">=",
"0.8.2"
]
]
}
],
"lcname": "pyexcel"
}
JSON
