A generic request and response interface for pyexcel web extensions.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.moban.d
docs
pyexcel_webio
tests
.gitignore
.moban.yml
.travis.yml
CHANGELOG.rst
LICENSE
MANIFEST.in
Makefile
README.rst
pyexcel_webio.yaml
requirements.txt
rnd_requirements.txt
setup.cfg
setup.py
test.bat
test.sh

README.rst

pyexcel-webio - Let you focus on data, instead of file formats

https://raw.githubusercontent.com/pyexcel/pyexcel.github.io/master/images/patreon.png https://api.travis-ci.org/pyexcel-webwares/pyexcel-webio.svg?branch=master

Support the project

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.

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 receive early 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 constraints

Fonts, colors and charts are not supported.

Introduction

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.

Installation

You can install pyexcel-webio via pip:

$ pip install pyexcel-webio

or clone it and install it:

$ git clone https://github.com/pyexcel-webwares/pyexcel-webio.git
$ cd pyexcel-webio
$ python setup.py install

Known extensions

framework plugin/middleware/extension
Flask Flask-Excel
Django django-excel
Pyramid pyramid-excel

Usage

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.

  1. 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(".")[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)
    
  2. 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
    
  3. 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 guide

Development steps for code changes

  1. git clone https://github.com/pyexcel/pyexcel-webio.git
  2. cd pyexcel-webio

Upgrade your setup tools and pip. They are needed for development and testing only:

  1. pip install --upgrade setuptools pip

Then install relevant development requirements:

  1. pip install -r rnd_requirements.txt # if such a file exists
  2. pip install -r requirements.txt
  3. pip install -r tests/requirements.txt

Once you have finished your changes, please provide test case(s), relevant documentation and update CHANGELOG.rst.

Note

As 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 contribution

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:

$ make

On Windows systems, please issue this command:

> test.bat

How to update test environment and update documentation

Additional steps are required:

  1. pip install moban
  2. git clone https://github.com/moremoban/setupmobans.git # generic setup
  3. git clone https://github.com/pyexcel/pyexcel-commons.git commons
  4. make your changes in .moban.d directory, then issue command moban

What is pyexcel-commons

Many information that are shared across pyexcel projects, such as: this developer guide, license info, etc. are stored in pyexcel-commons project.

What is .moban.d

.moban.d stores the specific meta data for the library.

Acceptance criteria

  1. Has Test cases written
  2. Has all code lines tested
  3. Passes all Travis CI builds
  4. Has fair amount of documentation if your change is complex
  5. Please update CHANGELOG.rst
  6. Please add yourself to CONTRIBUTORS.rst
  7. Agree on NEW BSD License for your contribution

License

New BSD License