skip to navigation
skip to content

pyexcel-handsontable 0.0.1

A pyexcel plugin to render data as handsontable in html pages

Known constraints

Fonts, colors and charts are not supported.

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

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')

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

Installation

You can install it via pip:

$ pip install pyexcel-handsontable

or clone it and install it:

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

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 to. 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.

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

In order to update test environment, and documentation, additional steps are required:

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

What is 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.

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.

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

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

 
File Type Py Version Uploaded on Size
pyexcel-handsontable-0.0.1.tar.gz (md5) Source 2017-06-19 6KB
pyexcel_handsontable-0.0.1-py2-none-any.whl (md5) Python Wheel 2.7 2017-06-19 10KB