Package: pyexcel-webio
Support the projectIf your company has embedded pyexcel and its components into a revenue generating
product, pleasesupport me on patreonto
maintain the project and develop it further.If you are an individual, you are welcome to support me too on patreon and for however long
you feel like. As a patreon, you will receiveearly access to pyexcel related contents.With your financial support, I will be able to invest
a little bit more time in coding, documentation and writing interesting posts.Known constraintsFonts, colors and charts are not supported.Introductionpyexcel-webiois a tiny interface library to unify the web extensions that usespyexcel. You may use it to write a web extension for your faviourite Python web framework.InstallationYou can install pyexcel-webio via pip:$pipinstallpyexcel-webioor clone it and install it:$gitclonehttps://github.com/pyexcel/pyexcel-webio.git$cdpyexcel-webio$pythonsetup.pyinstallKnown extensionsframeworkplugin/middleware/extensionFlaskFlask-ExcelDjangodjango-excelPyramidpyramid-excelUsageThis small section outlines the steps to adaptpyexcel-webiofor your favourite web framework. For illustration purpose, I tookFlaskmicro-framework as an example.InheritExcelInputclass and implementload_single_sheetandload_bookmethods depending on the parameters you will have. For example,Flask.Requestput the incoming file inFlask.Request.filesand the key is the field name in the html form:from flask import Flask, Request
import pyexcel as pe
from pyexcel.ext import webio

class ExcelRequest(webio.ExcelInput, Request):
    def _get_file_tuple(self, field_name):
        filehandle = self.files[field_name]
        filename = filehandle.filename
        extension = filename.split(".")[1]
        return extension, filehandle

    def load_single_sheet(self, field_name=None, sheet_name=None,
                          **keywords):
        file_type, file_handle = self._get_file_tuple(field_name)
        return pe.get_sheet(file_type=file_type,
                            content=file_handle.read(),
                            sheet_name=sheet_name,
                            **keywords)

    def load_book(self, field_name=None, **keywords):
        file_type, file_handle = self._get_file_tuple(field_name)
        return pe.get_book(file_type=file_type,
                           content=file_handle.read(),
                           **keywords)Plugin in a response method that has the following signature:def your_func(content, content_type=None, status=200):
    ....or a response class has the same signature:class YourClass:
    def __init__(self, content, content_type=None, status=200):
    ....For example, withFlask, it is just a few lines:from flask import Response


webio.ExcelResponse = ResponseThen make the proxy formake_responseseries by simply copying the following lines to your extension:from pyexcel.ext.webio import (
    make_response,
    make_response_from_array,
    make_response_from_dict,
    make_response_from_records,
    make_response_from_book_dict
)Development guideDevelopment steps for code changesgit clonehttps://github.com/pyexcel/pyexcel-webio.gitcd pyexcel-webioUpgrade your setup tools and pip. They are needed for development and testing only:pip install –upgrade setuptools pipThen install relevant development requirements:pip install -r rnd_requirements.txt # if such a file existspip install -r requirements.txtpip install -r tests/requirements.txtOnce you have finished your changes, please provide test case(s), relevant documentation
and update CHANGELOG.rst.NoteAs to rnd_requirements.txt, 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.How to test your contributionAlthoughnoseanddoctestare both used in code testing, it is adviable that unit tests are put in tests.doctestis 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.batHow to update test environment and update documentationAdditional steps are required:pip install mobangit clonehttps://github.com/moremoban/setupmobans.git# generic setupgit clonehttps://github.com/pyexcel/pyexcel-commons.gitcommonsmake your changes in.moban.ddirectory, then issue commandmobanWhat is pyexcel-commonsMany information that are shared across pyexcel projects, such as: this developer guide, license info, etc. are stored inpyexcel-commonsproject.What is .moban.d.moban.dstores the specific meta data for the library.Acceptance criteriaHas Test cases writtenHas all code lines testedPasses all Travis CI buildsHas fair amount of documentation if your change is complexPlease update CHANGELOG.rstPlease add yourself to CONTRIBUTORS.rstAgree on NEW BSD License for your contributionLicenseNew BSD LicenseChange log0.1.4 - 23.10.2017#105, remove gease
from setup_requires, introduced by 0.1.3.removed testing against python 2.60.1.3 - 20.10.2017added#103, include LICENSE file
in MANIFEST.in, meaning LICENSE file will appear in the released tar ball.updatedTake pyexcel 0.5.5 as dependency0.1.2 - 12.07.2017AddedTo bring isave_as and isave_book_as to web clientsUpdatedreplaced monkey-patching initialization step. For all extension developer,
please call init_webio(your_response_function)0.1.1 - 07.07.2017Updated#5: explicitly seek
at 0 for incoming file0.1.0 - 06.07.2017AddedTo bring iget_array, iget_records to web clientsTo facilitate the use of pyexcel-handsontable, pyexcel-pygal,
pyexcel-matplotlib0.0.11 - 04.03.2017Updated#4: extra keywords
were not passed on to pyexcel0.0.10 - 22.12.2016Updated#3: raise exception
if uploaded file has no content read.0.0.9 - 22.12.2016UpdatedFlask-Excelissue 19:
sheet_name parameter to control sheet nameuse pyexcel v0.4.00.0.8 - 28.10.2016Updateduse pyexcel v0.3.00.0.7 - 01.06.2016Updateduse pyexcel v0.2.2