Skip to content

bdeeney/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

A list of file formats supported by external plugins
Package name Supported file formats Dependencies Python versions

pyexcel-io

csv, csvz1, tsv, tsvz2

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

Installation

You can install it via pip:

or clone it and install it:

Usage

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

>>> import pyexcel >>> # make sure you had pyexcel-xls pip-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")

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 os >>> os.unlink("your_file.xls")

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


  1. zipped csv file

  2. zipped tsv file

About

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

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 99.6%
  • Other 0.4%