pyexcel 0.5.0

A wrapper library that provides one API to read, manipulate and write data in different excel formats

Known constraints

Fonts, colors and charts are not supported.

Feature Highlights

1. One API to handle multiple data sources:

   • physical file

   • memory file

   • SQLAlchemy table

   • Django Model

   • Python data stuctures: dictionary, records and array

2. One application programming interface(API) to read and write data in various excel file formats.

Available Plugins

A list of file formats supported by external plugins

Package name	Supported file formats	Dependencies	Python versions
pyexcel-io	csv, csvz [2], tsv, tsvz [3]		2.6, 2.7, 3.3, 3.4, 3.5, 3.6 pypy
pyexcel-xls	xls, xlsx(read only), xlsm(read only)	xlrd, xlwt	same as above
pyexcel-xlsx	xlsx	openpyxl	same as above
pyexcel-xlsxw	xlsx(write only)	XlsxWriter	same as above
pyexcel-ods3	ods	ezodf, lxml	2.6, 2.7, 3.3, 3.4 3.5, 3.6
pyexcel-ods	ods	odfpy	same as above
pyexcel-odsr	ods(read only)	lxml	same as above
pyexcel-text	(write only)json, rst, mediawiki, html, latex, grid, pipe, orgtbl, plain simple	tabulate	2.6, 2.7, 3.3, 3.4 3.5, pypy, pypy3
pyexcel-handsontable	handsontable in html	handsontable	same as above [1]
pyexcel-pygal	svg chart	pygal	same as above [1]

[1] (1,2)

coming soon

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’).

Footnotes

[2]

zipped csv file

[3]

zipped tsv file

Installation

You can install it via pip:

$ pip install pyexcel

or clone it and install it:

$ git clone https://github.com/pyexcel/pyexcel.git
$ cd pyexcel
$ python setup.py install

Usage

>>> import pyexcel
>>> content = "1,2,3\n3,4,5"
>>> sheet = pyexcel.Sheet()
>>> sheet.csv = content
>>> sheet.array
[[1, 2, 3], [3, 4, 5]]
>>> with open("myfile.xlsx", "wb") as output:
...     write_count_not_used = output.write(sheet.xlsx)

Suppose you have the following data in a dictionary:

Name	Age
Adam	28
Beatrice	29
Ceri	30
Dean	26

you can easily save it into an excel file, using the following code.

>>> import pyexcel
>>> # make sure you had pyexcel-xls installed
>>> a_list_of_dictionaries = [
...     {
...         "Name": 'Adam',
...         "Age": 28
...     },
...     {
...         "Name": 'Beatrice',
...         "Age": 29
...     },
...     {
...         "Name": 'Ceri',
...         "Age": 30
...     },
...     {
...         "Name": 'Dean',
...         "Age": 26
...     }
... ]
>>> pyexcel.save_as(records=a_list_of_dictionaries, dest_file_name="your_file.xls")

Here are the method to obtain the records:

>>> import pyexcel as pe
>>> records = pe.iget_records(file_name="your_file.xls")
>>> for record in records:
...     print("%s is aged at %d" % (record['Name'], record['Age']))
Adam is aged at 28
Beatrice is aged at 29
Ceri is aged at 30
Dean is aged at 26
>>> pe.free_resources()

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.

Support the project

If your company has embedded pyexcel and its components into a revenue generating product, please support me on patreon to maintain the project and develop it further.

If you are an individual, you are welcome to support me too on patreon and for however long you feel like to. As a patreon, you will receive early access to pyexcel related contents.

With your financial support, I will be able to invest a little bit more time in coding, documentation and writing interesting posts.

Development guide

Development steps for code changes

1. git clone https://github.com/pyexcel/pyexcel.git

2. cd pyexcel

Upgrade your setup tools and pip. They are needed for development and testing only:

1. pip install –upgrade setuptools pip

Then install relevant development requirements:

1. pip install -r rnd_requirements.txt # if such a file exists

2. pip install -r requirements.txt

3. pip install -r tests/requirements.txt

In order to update test environment, and documentation, additional steps are required:

1. pip install moban

2. git clone https://github.com/pyexcel/pyexcel-commons.git commons

3. make your changes in .moban.d directory, then issue command moban

What is rnd_requirements.txt

Usually, it is created when a dependent library is not released. Once the dependecy is installed(will be released), the future version of the dependency in the requirements.txt will be valid.

What is pyexcel-commons

Many information that are shared across pyexcel projects, such as: this developer guide, license info, etc. are stored in pyexcel-commons project.

What is .moban.d

.moban.d stores the specific meta data for the library.

How to test your contribution

Although nose and doctest are both used in code testing, it is adviable that unit tests are put in tests. doctest is incorporated only to make sure the code examples in documentation remain valid across different development releases.

On Linux/Unix systems, please launch your tests like this:

$ make

On Windows systems, please issue this command:

> test.bat

License

New BSD License

Change log

0.5.0 - 19.06.2017

Added

1. Sheet.top() and Sheet.top_left() for data browsing

2. add html as default rich display in Jupyter notebook when pyexcel-text and pyexcel-chart is installed

3. add svg as default rich display in Jupyter notebook when pyexcel-chart and one of its implementation plugin(pyexcel-pygal, etc.) are is installed

4. new dictionary source supported: a dictionary of key value pair could be read into a sheet.

5. 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

6. 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.

7. #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

1. array is passed to pyexcel.Sheet as reference. it means your array data will be modified.

Removed

1. pyexcel.Writer and pyexcel.BookWriter were removed

2. pyexcel.load_book_from_sql and pyexcel.load_from_sql were removed

3. pyexcel.deprecated.load_from_query_sets, pyexcel.deprecated.load_book_from_django_models and pyexcel.deprecated.load_from_django_model were removed

4. Removed plugin loading code and lml is used instead

0.4.5 - 17.03.2017

Updated

1. #80: remove pyexcel-chart import from v0.4.x

0.4.4 - 06.02.2017

Updated

1. #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.

2. #74: Not able to handle decimal.Decimal

Removed

1. remove get_{{file_type}}_stream functions from pyexcel.Sheet and pyexcel.Book introduced since 0.4.3.

0.4.3 - 26.01.2017

Added

1. ‘.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

1. Better error reporting when an unknown parameters or unsupported file types were given to the signature functions.

0.4.2 - 17.01.2017

Updated

1. 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.

2. 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.

3. 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.

4. #69: better documentation for save_book_as.

0.4.1 - 23.12.2016

Updated

1. #68: regression save_to_memory() should have returned a stream instance.

0.4.0 - 22.12.2016

Added

1. Flask-Excel issue 19 allow sheet_name parameter

2. pyexcel-xls issue 11 case-insensitive for file_type. xls and XLS are treated in the same way

Updated

1. # 66: export_columns is ignored

2. Update dependency on pyexcel-io v0.3.0

0.3.3 - 07.11.2016

Updated

1. # 63: cannot display empty sheet(hence book with empty sheet) as texttable

0.3.2 - 02.11.2016

Updated

1. # 62: optional module import error become visible.

0.3.0 - 28.10.2016

Added:

1. file type setters for Sheet and Book, and its documentation

2. iget_records returns a generator for a list of records and should have better memory performance, especially dealing with large csv files.

3. iget_array returns a generator for a list of two dimensional array and should have better memory performance, especially dealing with large csv files.

4. Enable pagination support, and custom row renderer via pyexcel-io v0.2.3

Updated

1. Take isave_as out from save_as. Hence two functions are there for save a sheet as

2. # 60: encode ‘utf-8’ if the console is of ascii encoding.

3. # 59: custom row renderer

4. # 56: set cell value does not work

5. pyexcel.transpose becomes pyexcel.sheets.transpose

6. 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()

7. ~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:

1. content and out_file as function parameters to the signature functions are no longer supported.

2. SourceFactory and RendererFactory are removed

3. 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

4. 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

5. the following functions have been removed

   • add_formatter

   • remove_formatter

   • clear_formatters

   • freeze_formatters

   • add_filter

   • remove_filter

   • clear_filters

   • freeze_formatters

6. pyexcel.Sheet.filter has been re-implemented and all filters were removed:

   • pyexcel.formatters.SheetFormatter

0.2.5 - 31.08.2016

Updated:

1. # 58: texttable should have been made as compulsory requirement

0.2.4 - 14.07.2016

Updated:

1. For python 2, writing to sys.stdout by pyexcel-cli raise IOError.

0.2.3 - 11.07.2016

Updated:

1. 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:

1. Explicit imports, no longer needed

2. Depends on latest setuptools 18.0.1

3. 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:

1. add pyexcel-text file types as attributes of pyexcel.Sheet and pyexcel.Book, related to issue 31

2. auto import pyexcel-text if it is pip installed

Updated:

1. code refactoring done for easy addition of sources.

2. bug fix issue 29, Even if the format is a string it is displayed as a float

3. pyexcel-text is no longer a plugin to pyexcel-io but to pyexcel.sources, see pyexcel-text issue #22

Removed:

1. pyexcel.presentation is removed. No longer the internal decorate @outsource is used. related to issue 31

0.2.0 - 17.01.2016

Updated

1. adopt pyexcel-io yield key word to return generator as content

2. pyexcel.save_as and pyexcel.save_book_as get performance improvements

0.1.7 - 03.07.2015

Added

1. Support pyramid-excel which does the database commit on its own.

0.1.6 - 13.06.2015

Added

1. get excel data from a http url

0.0.13 - 07.02.2015

Added

1. Support django

2. texttable as default renderer

0.0.12 - 25.01.2015

Added

1. Added sqlalchemy support

0.0.10 - 15.12.2015

Added

1. added csvz and tsvz format

0.0.4 - 12.10.2014

Updated

1. Support python 3

0.0.1 - 14.09.2014

Features:

1. read and write csv, ods, xls, xlsx and xlsm files(which are referred later as excel files)

2. various iterators for the reader

3. row and column filters for the reader

4. utilities to get array and dictionary out from excel files.

5. cookbok receipes for some common and simple usage of this library.