Signature functions

Import data into Python

This library provides one application programming interface to read data from one of the following data sources:

  • physical file
  • memory file
  • SQLAlchemy table
  • Django Model
  • Python data stuctures: dictionary, records and array

and to transform them into one of the data structures:

  • two dimensinal array
  • a dictionary of one dimensional arrays
  • a list of dictionaries
  • a dictionary of two dimensional arrays
  • a Sheet
  • a Book

Four data access functions

It is believed that once a Python developer could easily operate on list, dictionary and various mixture of both. This library provides four module level functions to help you obtain excel data in those formats. Please refer to “A list of module level functions”, the first three functions operates on any one sheet from an excel book and the fourth one returns all data in all sheets in an excel book.

A list of module level functions
Functions Psudo name Python name
get_array() two dimensional array a list of lists
get_dict() a dictionary of one dimensional arrays an ordered dictionary of lists
get_records() a list of dictionaries a list of dictionaries
get_book_dict() a dictionary of two dimensional arrays a dictionary of lists of lists

See also:

Two native functions

In cases where the excel data needs custom manipulations, a pyexcel user got a few choices: one is to use Sheet and Book, the other is to look for more sophisticated ones:

  • Pandas, for numerical analysis
  • Do-it-yourself
Functions Returns
get_sheet() Sheet
get_book() Book

Export data from Python

This library provides one application programming interface to transform them into one of the data structures:

  • two dimensinal array
  • a (ordered) dictionary of one dimensional arrays
  • a list of dictionaries
  • a dictionary of two dimensional arrays
  • a Sheet
  • a Book

and write to one of the following data sources:

  • physical file
  • memory file
  • SQLAlchemy table
  • Django Model
  • Python data stuctures: dictionary, records and array

Here are the two functions:

Functions Description
save_as() Works well with single sheet file
save_book_as() Works with multiple sheet file

See also:

Data transportation/transcoding

Based the capability of this library, it is capable of transporting your data in between any of these data sources:

  • physical file
  • memory file
  • SQLAlchemy table
  • Django Model
  • Python data stuctures: dictionary, records and array

See also: