Fonts, colors and charts are not supported.
Here is a typical conversation between the developer and the user:
User: "I have uploaded an excel file"
"but your application says un-supported file format"
Developer: "Did you upload an xlsx file or a csv file?"
User: "Well, I am not sure. I saved the data using "
"Microsoft Excel. Surely, it must be in an excel format."
Developer: "OK. Here is the thing. I were not told to support"
"all available excel formats in day 1. Live with it"
"or delay the project x number of days."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 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 common usability problem when developing an excel file driven web applications for non-technical office workers: such as office assistant, human resource administrator. The fact is that not all people know the difference among various excel formats: csv, xls, xlsx. Instead of training those people about file formats, this library helps web developers to handle most of the excel file formats by providing a common programming interface. To add a specific excel file format to you application, all you need is to install an extra pyexcel plugin. No code change to your application. Looking at the community, this library and its associated ones try to become a small and easy to install alternative to Pandas.
The highlighted features are:
- excel data import into and export from databases
- turn uploaded excel file directly into Python data structure
- 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:
| Package name | Supported file formats | Dependencies | Python versions |
|---|---|---|---|
2.6, 2.7, 3.3, 3.4, 3.5, 3.6 pypy |
|||
xls, xlsx(read only), xlsm(read only) |
same as above |
||
| pyexcel-xlsx | xlsx | openpyxl | same as above |
| pyexcel-xlsxw | xlsx(write only) | XlsxWriter | same as above |
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 |
(write only)json, rst, mediawiki, html, latex, grid, pipe, orgtbl, plain simple |
2.6, 2.7, 3.3, 3.4 3.5, pypy, pypy3 |
||
| pyexcel-handsontable | handsontable in html | handsontable | same as above |
| pyexcel-chart | svg chart | pygal | same as above |
Footnotes
This library makes information 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:
- to provide one uniform programming interface to handle csv, tsv, xls, xlsx, xlsm and ods formats.
- 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.
- 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.
You can install it via pip:
$ pip install Flask-Excelor clone it and install it:
$ git clone https://github.com/pyexcel/Flask-Excel.git
$ cd Flask-Excel
$ python setup.py installHere 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("/export", methods=['GET'])
def export_records():
return excel.make_response_from_array([[1,2], [3, 4]], "csv",
file_name="export_data")
if __name__ == "__main__":
app.run()Development steps for code changes
- git clone https://github.com/pyexcel/Flask-Excel.git
- cd Flask-Excel
Upgrade your setup tools and pip. They are needed for development and testing only:
- pip install --upgrade setuptools pip
Then install relevant development requirements:
- pip install -r rnd_requirements.txt # if such a file exists
- pip install -r requirements.txt
- pip install -r tests/requirements.txt
In order to update test environment, and documentation, additional steps are required:
- pip install moban
- git clone https://github.com/pyexcel/pyexcel-commons.git commons
- make your changes in .moban.d directory, then issue command moban
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.
Many information that are shared across pyexcel projects, such as: this developer guide, license info, etc. are stored in pyexcel-commons project.
.moban.d stores the specific meta data for the library.
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:
$ makeOn Windows systems, please issue this command:
> test.batNew BSD License
If your company has embedded pyexcel and its components into a revenue generating product, please support me on patreon to maintain the project and develop it further.