pyexcel - Let you focus on data, instead of file 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 [1], tsv, tsvz [2]		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
pyexcel-chart	svg chart	pygal	same as above

Footnotes

[1]	zipped csv file

[2]	zipped tsv file

Installation

You can install it via pip:

$ pip install pyexcel

or clone it and install it:

$ git clone http://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

Acknowledgement

All great work have done by odf, ezodf, xlrd, xlwt, tabulate and other individual developers. This library unites only the data access code.

.. testcode::
   :hide:

   >>> import os
   >>> os.unlink("your_file.xls")
   >>> os.unlink("myfile.xlsx")

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

Support the project

If your company has embedded pyexcel and its components into a revenue generating product, please support me on patreon.