Skip to main content

A pyramid extension that provides one application programming interface to read and write data in different excel file formats

Project description

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

pyramid-excel is based on pyexcel and makes it easy to consume/produce information stored in excel files over HTTP protocol as well as on file system. This library can turn the excel data into a list of lists, a list of records(dictionaries), dictionaries of lists. And vice versa. Hence it lets you focus on data in Pyramid based web development, instead of file formats.

The idea originated from the problem of the illiteracy of excel file formats of non-technical office workers: such as office assistant, human resource administrator. There is nothing with the un-deniable fact that some people do not know the difference among various excel formats. It becomes usability problem to those people when a web service cannot parse the excel file that they saved using Microsoft Excel. Instead of training those people about file formats, this library helps web developers to handle most of the excel file formats by unifying the programming interface to most of the excel readers and writers.

The highlighted features are:

  1. excel data import into and export from databases
  2. turn uploaded excel file directly into Python data struture
  3. pass Python data structures as an excel file download
  4. provide data persistence as an excel file in server side
  5. supports csv, tsv, csvz, tsvz by default and other formats are supported via the following plugins:
A list of file formats supported by external plugins
Plugins Supported file formats
pyexcel-xls xls, xlsx(r), xlsm(r)
pyexcel-xlsx xlsx
pyexcel-ods3 ods (python 2.6, 2.7, 3.3, 3.4)
pyexcel-ods ods (python 2.6, 2.7)
pyexcel-text (write only)json, rst, mediawiki, latex, grid, pipe, orgtbl, plain simple

This library makes infomation processing involving various excel files as easy as processing array, dictionary when processing file upload/download, data import into and export from SQL databases, information analysis and persistence. It uses pyexcel and its plugins:

  1. to provide one uniform programming interface to handle csv, tsv, xls, xlsx, xlsm and ods formats.
  2. to provide one-stop utility to import the data in uploaded file into a database and to export tables in a database as excel files for file download.
  3. to provide the same interface for information persistence at server side: saving a uploaded excel file to and loading a saved excel file from file system.

Known constraints

Fonts, colors and charts are not supported.

Installation

You can install it via pip:

$ pip install pyramid-excel

or clone it and install it:

$ git clone http://github.com/pyexcel/pyramid-excel.git
$ cd pyramid-excel
$ python setup.py install

Setup

Once the pyramid_excel is installed, you must use the config.include mechanism to include it into your Pyramid project’s configuration:

config = Configurator(.....)
config.include('pyramid_excel')

Alternately, you may activate the extension by changing your application’s .ini file by adding it to the pyramid.includes list:

pyramid.includes = pyramid_excel

License

New BSD License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pyramid-excel, version 0.0.3
Filename, size File type Python version Upload date Hashes
Filename, size pyramid-excel-0.0.3.zip (12.2 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page