Skip to content

chiyodad/pyexcel

 
 

Repository files navigation

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

image

image

image

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

Recently, pyexcel(0.2.2+) and its plugins(0.2.0+) started using newer version of setuptools. Please upgrade your setup tools before install latest pyexcel components:

$ pip install --upgrade setuptools

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

>>> 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:
...     output.write(sheet.xlsx)

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

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.

About

Python Wrapper that provides one API for reading, manipulating and writing data in csv, ods, xls, xlsx and xlsm files

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 99.6%
  • Other 0.4%