pyexcel 0.2.2

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

Plugins	Supported file formats
pyexcel-io	csv, csvz, tsv, tsvz
pyexcel-xls	xls, xlsx(r), xlsm(r)
pyexcel-xlsx	xlsx
pyexcel-ods	ods (python 2.6, 2.7 only)
pyexcel-ods3	ods
pyexcel-text	(write only)json, rst, mediawiki,latex, grid, pipe, orgtbl, plain simple

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

Installation of individual plugins , please refer to individual plugin page.

Usage

JSON

>>> import pyexcel as pe
>>> an_array = [[1,2]]
>>> sheet = pe.Sheet(an_array)
>>> sheet.json
'{"pyexcel sheet": [[1, 2]]}'

Note: It is available with pyexcel v0.2.1 and pyexcel-text 0.2.0

TSV

>>> sheet.tsv
'1\t2\r\n'

Note: TSV and the rest of the formats are available with pyexcel v0.2.2 and its plugins at version 0.2.0+ only

CSV

>>> sheet.csv
'1,2\r\n'

Documentation

Documentation is hosted at read the docs and pyhosted

Development guide

Development steps for code changes

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

2. cd pyexcel

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

4. pip install -r requirements.txt

5. pip install -r tests/requirements.txt

In order to update test envrionment, and documentation, additional setps are required:

1. pip install moban

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

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

What is rnd_requirements.txt

Usually, it is created when a depdent 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 test

On Windows systems, please issue this command:

> test.bat

License

New BSD License

Acknowledgement

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

Change log

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 refactored sources 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 imporvements