A generic request and response interface for pyexcel web extensions.
Fonts, colors and charts are not supported.
pyexcel-webio is a tiny interface library to unify the web extensions that uses pyexcel . You may use it to write a web extension for your faviourite Python web framework.
You can install it via pip:
$ pip install pyexcel-webio
or clone it and install it:
$ git clone http://github.com/pyexcel/pyexcel-webio.git $ cd pyexcel-webio $ python setup.py install
This small section outlines the steps to adapt pyexcel-webio for your favourite web framework. For illustration purpose, I took Flask micro-framework as an example.
Inherit ExcelInput class and implement load_single_sheet and load_book methods depending on the parameters you will have. For example, Flask.Request put the incoming file in Flask.Request.files and 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(".") 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, with Flask, it is just a few lines:
from flask import Response webio.ExcelResponse = Response
Then make the proxy for make_response series 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 steps for code changes
Upgrade your setup tools and pip. They are needed for development and testing only:
Then install relevant development requirements:
In order to update test environment, and documentation, additional steps are required:
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:
On Windows systems, please issue this command:
New BSD License