Skip to main content

pyexcel-htmlr - Let you focus on data, instead of html format

https://raw.githubusercontent.com/pyexcel/pyexcel.github.io/master/images/patreon.png https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg https://travis-ci.org/pyexcel/pyexcel-htmlr.svg?branch=master https://codecov.io/gh/pyexcel/pyexcel-htmlr/branch/master/graph/badge.svg https://badge.fury.io/py/pyexcel-htmlr.svg https://pepy.tech/badge/pyexcel-htmlr/month https://img.shields.io/gitter/room/gitterHQ/gitter.svg https://readthedocs.org/projects/pyexcel-htmlr/badge/?version=latest

Support the project

If your company has embedded pyexcel and its components into a revenue generating product, please support me on github, patreon or bounty source to maintain the project and develop it further.

If you are an individual, you are welcome to support me too and for however long you feel like. As my backer, 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.

Installation

You can install pyexcel-htmlr via pip:

$ pip install pyexcel-htmlr

or clone it and install it:

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

Usage

As a standalone library

Read from an html file

Here’s the sample code:

>>> from pyexcel_htmlr import get_data
>>> data = get_data("your_file.html")
>>> import json
>>> print(json.dumps(data))
{"Table 1": [[1, 2, 3], [4, 5, 6]], "Table 2": [["row 1", "row 2", "row 3"]]}

Read from an html from memory

Continue from previous example:

>>> # This is just an illustration
>>> # In reality, you might deal with html file upload
>>> # where you will read from requests.FILES['YOUR_HTML_FILE']
>>> with open('your_file.html', 'r') as html_file:
...    io = StringIO(html_file.read().encode())
...    data = get_data(io)
>>> print(json.dumps(data))
{"Table 1": [[1, 2, 3], [4, 5, 6]], "Table 2": [["row 1", "row 2", "row 3"]]}

Pagination feature

Let’s assume the following file is a huge html file:

>>> huge_data = [
...     [1, 21, 31],
...     [2, 22, 32],
...     [3, 23, 33],
...     [4, 24, 34],
...     [5, 25, 35],
...     [6, 26, 36]
... ]
>>> sheetx = {
...     "Table 1": huge_data
... }
>>> pe.save_book_as(dest_file_name="huge_file.html", bookdict=sheetx)

And let’s pretend to read partial data:

>>> partial_data = get_data("huge_file.html", start_row=2, row_limit=3)
>>> print(json.dumps(partial_data))
{"Table 1": [[3, 23, 33], [4, 24, 34], [5, 25, 35]]}

And you could as well do the same for columns:

>>> partial_data = get_data("huge_file.html", start_column=1, column_limit=2)
>>> print(json.dumps(partial_data))
{"Table 1": [[21, 31], [22, 32], [23, 33], [24, 34], [25, 35], [26, 36]]}

Obvious, you could do both at the same time:

>>> partial_data = get_data("huge_file.html",
...     start_row=2, row_limit=3,
...     start_column=1, column_limit=2)
>>> print(json.dumps(partial_data))
{"Table 1": [[23, 33], [24, 34], [25, 35]]}

As a pyexcel plugin

No longer, explicit import is needed since pyexcel version 0.2.2. Instead, this library is auto-loaded. So if you want to read data in html format, installing it is enough.

Reading from an html file

Here is the sample code:

>>> import pyexcel as pe
>>> sheet = pe.get_book(file_name="your_file.html")
>>> sheet
Table 1:
+---+---+---+
| 1 | 2 | 3 |
+---+---+---+
| 4 | 5 | 6 |
+---+---+---+
Table 2:
+-------+-------+-------+
| row 1 | row 2 | row 3 |
+-------+-------+-------+

Reading from a IO instance

You got to wrap the binary content with stream to get html working:

>>> # This is just an illustration
>>> # In reality, you might deal with html file upload
>>> # where you will read from requests.FILES['YOUR_HTML_FILE']
>>> htmlfile = "your_file.html"
>>> with open(htmlfile, "rb") as f:
...     content = f.read()
...     r = pe.get_book(file_type="html", file_content=content)
...     print(r)
...
Table 1:
+---+---+---+
| 1 | 2 | 3 |
+---+---+---+
| 4 | 5 | 6 |
+---+---+---+
Table 2:
+-------+-------+-------+
| row 1 | row 2 | row 3 |
+-------+-------+-------+

License

New BSD License

Developer guide

Development steps for code changes

  1. git clone https://github.com/pyexcel/pyexcel-htmlr.git

  2. cd pyexcel-htmlr

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.

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

Before you commit

Please run:

$ make format

so as to beautify your code otherwise travis-ci may fail your unit test.

And make sure you would have run moban command

Additional steps are required:

  1. pip install moban

  2. make your changes in .moban.d directory, then issue command moban

  3. moban

otherwise travis-ci may also fail your unit test.

What is .moban.d

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

Change log

0.6.0 - 9.10.2020

Updated

  1. New style xlsx plugins, promoted by pyexcel-io v0.6.2

0.5.2 - 23.10.2017

updated

  1. pyexcel pyexcel#105, remove gease from setup_requires, introduced by 0.5.1.

  2. remove python2.6 test support

  3. update its dependecy on pyexcel-io to 0.5.3

0.5.1 - 20.10.2017

added

  1. pyexcel#103, include LICENSE file in MANIFEST.in, meaning LICENSE file will appear in the released tar ball.

0.5.0 - 30.08.2017

Updated

  1. put dependency on pyexcel-io 0.5.0, which uses cStringIO instead of StringIO. Hence, there will be performance boost in handling files in memory.

  2. version jumped because it will be easy to see pyexcel-htmlr depends on pyexcel-io v0.5.0

Relocated

  1. type detection code is being relocated into pyexcel-io

0.0.1 - 26-07-2017

Metadata

Release files for pyexcel-htmlr 0.6.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pyexcel-htmlr 0.6.0
File Size Uploaded Provenance Actions
pyexcel-htmlr-0.6.0.tar.gz 24.6 kB Without provenance Details for pyexcel-htmlr-0.6.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for pyexcel-htmlr 0.6.0
File Interpreter ABI Platform Actions
pyexcel_htmlr-0.6.0-py2.py3-none-any.whl Python 2, Python 3 none any Details for pyexcel_htmlr-0.6.0-py2.py3-none-any.whl

Total release size: 32.7 kB

Release files / pyexcel-htmlr-0.6.0.tar.gz

Download URL pyexcel-htmlr-0.6.0.tar.gz
Size 24.6 kB
Tags Source
SHA-256 checksum
How to use checksums
5777860c4b961ac709e92a14b4e997e55b275edda6f2102eaf8581fd1481f771
BLAKE2b-256 checksum
How to use checksums
02bf535b3d5b9c6547d7e649f8efa98d5030954fe460db40d92ff3fb846743e5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.8.6

Release files / pyexcel_htmlr-0.6.0-py2.py3-none-any.whl

Download URL pyexcel_htmlr-0.6.0-py2.py3-none-any.whl
Size 8.1 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
4514273a10862b9c1949cc0eac945f9fb3cd5a1090ca2b4bd1bf534cdd65c36c
BLAKE2b-256 checksum
How to use checksums
4c926113f017e460806552ba64eeafcd7f0829bc70f8d7fd203571712b53c22d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.8.6

Security for pyexcel-htmlr 0.6.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page