Skip to main content

A flask extension using pyexcel to read, manipulate and write data in different excel formats: csv, ods, xls, xlsx and xlsm.

Project description

https://api.travis-ci.org/chfw/Flask-Excel.svg?branch=v0.0.1 https://coveralls.io/repos/chfw/Flask-Excel/badge.png?branch=v0.0.1 https://readthedocs.org/projects/flask-excel/badge/?version=v0.0.1 https://pypip.in/version/Flask-Excel/badge.png https://pypip.in/d/Flask-Excel/badge.png https://pypip.in/py_versions/Flask-Excel/badge.png

Flask-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 Pythonic a list of lists, a list of records(dictionaries), dictionaries of lists. And vice versa. Hence it lets you focus on data in Flask 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. turn uploaded excel file directly into Python data struture
  2. pass Python data structures as an excel file download
  3. provide data persistence as an excel file in server side
  4. supports csv, tsv, csvz, tsvz by default and other formats are supported via the following plugins:

Available Plugins

Plugins Supported file formats
pyexcel-xls xls, xlsx(r), xlsm(r)
pyexcel-xlsx xlsx
pyexcel-ods ods (python 2.6, 2.7)
pyexcel-ods3 ods (python 2.7, 3.3, 3.4)

Known constraints

Fonts, colors and charts are not supported.

Installation

You can install it via pip:

$ pip install Flask-Excel

or clone it and install it:

$ git clone http://github.com/chfw/Flask-Excel.git
$ cd Flask-Excel
$ python setup.py install

Installation of individual plugins , please refer to individual plugin page.

Usage

Here are some example codes:

from flask import Flask, request, jsonify
from flask.ext import excel

app=Flask(__name__)

@app.route("/upload", methods=['GET', 'POST'])
def upload_file():
    if request.method == 'POST':
        return jsonify({"result": request.get_array(field_name='file')})
    return '''
    <!doctype html>
    <title>Upload an excel file</title>
    <h1>Excel file upload (csv, tsv, csvz, tsvz only)</h1>
    <form action="" method=post enctype=multipart/form-data>
    <p><input type=file name=file><input type=submit value=Upload>
    </form>
    '''

@app.route("/download", methods=['GET'])
def download_file():
    return excel.make_response_from_array([[1,2], [3, 4]], "csv")

if __name__ == "__main__":
    app.run()

Dependencies

  • Flask
  • pyexcel
  • pyexcel-webio

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 Flask-Excel, version 0.0.1
Filename, size File type Python version Upload date Hashes
Filename, size Flask-Excel-0.0.1.tar.gz (3.8 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page