Python Wrapper that provides one API for reading, manipulating and writing data in csv, ods, xls, xlsx and xlsm files
Python Other
Permalink
Failed to load latest commit information.
.moban.d fix #68: read pointer of the returned stream instance should have bee… Feb 6, 2017
docs fix doc build error due to unreleased 0.5.0 Feb 20, 2017
examples update documentation on examples Jan 23, 2017
pyexcel extend the exception to report and rule out pyexcel_xls Feb 22, 2017
tests addressing #76, try to verify if delimiter was not passed Feb 20, 2017
.gitignore normalized gitignore May 12, 2016
.moban.yml bug fix: enforce doctests on documentation by nose Oct 17, 2016
.travis.yml update change log. kick start 0.4.3 Jan 21, 2017
CHANGELOG.rst feature: dynamically load external renderers. related to #62 Feb 19, 2017
LICENSE welcome 2017 Jan 3, 2017
MANIFEST.in update pypy3 Apr 28, 2016
Makefile address #69: a bit more info on save_book_as Jan 16, 2017
README.rst fix #68: read pointer of the returned stream instance should have bee… Feb 6, 2017
document.bat fix #62: should not print the optional import as an error but info. d… Oct 30, 2016
document.sh fix #62: should not print the optional import as an error but info. d… Oct 30, 2016
min_requirements.txt pump up version to be 0.4.0 Dec 16, 2016
pyexcel.yml fix #75: provide documentation on reading tab separated csv file Feb 8, 2017
requirements.txt pump up version to be 0.4.0 Dec 16, 2016
rnd_requirements.txt install pyexcel itself Dec 16, 2016
setup.py merge with 0.4.x branch Feb 6, 2017
test.bat bug fix: enforce doctests on documentation by nose Oct 17, 2016
test.sh bug fix: enforce doctests on documentation by nose Oct 17, 2016

README.rst

pyexcel - Let you focus on data, instead of file formats

https://api.travis-ci.org/pyexcel/pyexcel.svg?branch=master https://codecov.io/github/pyexcel/pyexcel/coverage.png https://readthedocs.org/projects/pyexcel/badge/?version=latest

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

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 want to process the following excel data :

Name Age
Adam 28
Beatrice 29
Ceri 30
Dean 26

Here are the new method to obtain the records on demand:

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

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==7.1"

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 setps 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 test

On Windows systems, please issue this command:

> test.bat

License

New BSD License