A pyexcel plugin to render data as handsontable in html pages
JavaScript Python HTML CSS Shell Batchfile Makefile
Switch branches/tags
Nothing to show
Clone or download
Latest commit 0598a14 Jan 15, 2018

README.rst

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

https://raw.githubusercontent.com/pyexcel/pyexcel.github.io/master/images/patreon.png https://travis-ci.org/pyexcel-renderers/pyexcel-handsontable.svg?branch=master https://readthedocs.org/projects/pyexcel-handsontable/badge/?version=latest

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.

And your issues will get prioritized if you would like to become my patreon as pyexcel pro user.

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-handsontable is a rendering plugin to pyexcel and renders pyexcel.Sheet and pyexcel.Book into a handsontable in your web page. As long as you have a browser, you could view the data. However, please note that this library does not aim to replace any current excel softwares, such as Micorsoft Office. But it aims to extends the capability of a Python user/developer in viewing plain data.

Main features:

  1. transform your excel sheets into excel alike html file.
  2. embed your excel sheets into your web page

https://github.com/pyexcel/pyexcel-handsontable/raw/master/demo/screenshot.png

Here is one liner to use it with pyexcel:

import pyexcel as p

p.save_as(file_name='your.xls', dest_file_name='your.handsontable.html')

Alternatively, you can use this library with pyexcel cli module:

$ pip install pyexcel-cli
    $ pyexcel transcode your.xls your.handsontable.html

Please remember to give this file suffix always: handsontable.html. It is because handsontable.html triggers this plugin in pyexcel.

Installation

You can install pyexcel-handsontable via pip:

$ pip install pyexcel-handsontable

or clone it and install it:

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

Development guide

Development steps for code changes

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

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

Update styles

styles/style.scss control the look and feel of the frame. In order to view the changes in that file, you will need to compile, moban and install it. Here is the sequence of commands:

$ make css
$ moban
$ python setup.py install
$ make -C demo

Then please open handsontable.html from demo directory.

License

New BSD License