Metadata-Version: 1.1
Name: Flask-Excel
Version: 0.0.3
Summary: A flask extension that provides one application programming interface to read and write data in different excel file formats
Home-page: https://github.com/chfw/Flask-Excel
Author: C. W.
Author-email: wangc_2011@hotmail.com
License: New BSD
Description: ============================================================
        Flask-Excel - Let you focus on data, instead of file formats
        ============================================================
        
        .. image:: https://api.travis-ci.org/chfw/Flask-Excel.svg?branch=master
           :target: http://travis-ci.org/chfw/Flask-Excel
        
        .. image:: https://coveralls.io/repos/chfw/Flask-Excel/badge.svg
           :target: https://coveralls.io/r/chfw/Flask-Excel 
        
        .. image:: https://readthedocs.org/projects/flask-excel/badge/?version=latest
           :target: http://flask-excel.readthedocs.org/en/latest/
        
        .. image:: http://img.shields.io/gittip/chfw.svg
           :target: https://gratipay.com/chfw/
        
        **Flask-Excel** is based on `pyexcel <https://github.com/chfw/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 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:
        
        #. turn uploaded excel file directly into Python data struture
        #. pass Python data structures as an excel file download
        #. provide data persistence as an excel file in server side
        #. 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)                
        `text`_          write only)json, rst, mediawiki,
                         latex, grid, pipe, orgtbl, plain simple
        ================ ==========================================
        
        .. _pyexcel-xls: https://github.com/chfw/pyexcel-xls
        .. _pyexcel-xlsx: https://github.com/chfw/pyexcel-xlsx
        .. _pyexcel-ods: https://github.com/chfw/pyexcel-ods
        .. _pyexcel-ods3: https://github.com/chfw/pyexcel-ods3
        .. _pyexcel-text: https://github.com/chfw/pyexcel-text
        
        
        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()
        
        License
        ==========
        
        New BSD License
        
        
        Dependencies
        =============
        
        * Flask
        * pyexcel
        * pyexcel-webio
        
Keywords: API,Flask,Excel,pyexcel,xls,xlsx,ods,csv
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Web Environment
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Programming Language :: Python
Classifier: License :: OSI Approved :: BSD License
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: Implementation :: PyPy
