pyexcel-htmlr 0.6.0
read tables in html file as excel data
License: New BSD
Requires Python: >=3.6
Keywords: python

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

.. image:: https://raw.githubusercontent.com/pyexcel/pyexcel.github.io/master/images/patreon.png
   :target: https://www.patreon.com/chfw

.. image:: https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg
   :target: https://awesome-python.com/#specific-formats-processing

.. image:: https://travis-ci.org/pyexcel/pyexcel-htmlr.svg?branch=master
   :target: http://travis-ci.org/pyexcel/pyexcel-htmlr

.. image:: https://codecov.io/gh/pyexcel/pyexcel-htmlr/branch/master/graph/badge.svg
   :target: https://codecov.io/gh/pyexcel/pyexcel-htmlr

.. image:: https://badge.fury.io/py/pyexcel-htmlr.svg
   :target: https://pypi.org/project/pyexcel-htmlr


.. image:: https://pepy.tech/badge/pyexcel-htmlr/month
   :target: https://pepy.tech/project/pyexcel-htmlr/month


.. image:: https://img.shields.io/gitter/room/gitterHQ/gitter.svg
   :target: https://gitter.im/pyexcel/Lobby

.. image:: https://readthedocs.org/projects/pyexcel-htmlr/badge/?version=latest
   :target: http://pyexcel-htmlr.readthedocs.org/en/latest/


Support the project
================================================================================

If your company has embedded pyexcel and its components into a revenue generating
product, please support me on github, `patreon <https://www.patreon.com/bePatron?u=5537627>`_
or `bounty source <https://salt.bountysource.com/teams/chfw-pyexcel>`_ 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 <https://www.patreon.com/pyexcel/posts>`_.

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:

.. code-block:: bash

    $ pip install pyexcel-htmlr


or clone it and install it:

.. code-block:: bash

    $ 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:

.. code-block:: python

    >>> 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:

.. code-block:: python

    >>> # 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:

.. code-block:: python

   >>> 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:

.. code-block:: python

   >>> 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:

.. code-block:: python

   >>> 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:

.. code-block:: python

   >>> 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:

.. code-block:: python

    >>> 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:

.. code-block:: python

    >>> # 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

#. git clone https://github.com/pyexcel/pyexcel-htmlr.git
#. cd pyexcel-htmlr

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

#. pip install --upgrade setuptools pip

Then install relevant development requirements:

#. pip install -r rnd_requirements.txt # if such a file exists
#. pip install -r requirements.txt
#. 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


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:

#. pip install moban
#. make your changes in `.moban.d` directory, then issue command `moban`
#. 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**

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

0.5.2 - 23.10.2017
--------------------------------------------------------------------------------

**updated**

#. pyexcel `pyexcel#105 <https://github.com/pyexcel/pyexcel/issues/105>`_,
   remove gease from setup_requires, introduced by 0.5.1.
#. remove python2.6 test support
#. update its dependecy on pyexcel-io to 0.5.3

0.5.1 - 20.10.2017
--------------------------------------------------------------------------------

**added**

#. `pyexcel#103 <https://github.com/pyexcel/pyexcel/issues/103>`_, include
   LICENSE file in MANIFEST.in, meaning LICENSE file will appear in the released
   tar ball.

0.5.0 - 30.08.2017
--------------------------------------------------------------------------------

**Updated**

#. 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.
#. version jumped because it will be easy to see pyexcel-htmlr depends on
   pyexcel-io v0.5.0

**Relocated**

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

0.0.1 - 26-07-2017
--------------------------------------------------------------------------------