================================================================================
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
--------------------------------------------------------------------------------
Raw data
{
"_id": null,
"home_page": "https://github.com/pyexcel/pyexcel-htmlr",
"name": "pyexcel-htmlr",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "python",
"author": "chfw",
"author_email": "info@pyexcel.org",
"download_url": "https://files.pythonhosted.org/packages/02/bf/535b3d5b9c6547d7e649f8efa98d5030954fe460db40d92ff3fb846743e5/pyexcel-htmlr-0.6.0.tar.gz",
"platform": "",
"description": "================================================================================\npyexcel-htmlr - Let you focus on data, instead of html format\n================================================================================\n\n.. image:: https://raw.githubusercontent.com/pyexcel/pyexcel.github.io/master/images/patreon.png\n :target: https://www.patreon.com/chfw\n\n.. image:: https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg\n :target: https://awesome-python.com/#specific-formats-processing\n\n.. image:: https://travis-ci.org/pyexcel/pyexcel-htmlr.svg?branch=master\n :target: http://travis-ci.org/pyexcel/pyexcel-htmlr\n\n.. image:: https://codecov.io/gh/pyexcel/pyexcel-htmlr/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/pyexcel/pyexcel-htmlr\n\n.. image:: https://badge.fury.io/py/pyexcel-htmlr.svg\n :target: https://pypi.org/project/pyexcel-htmlr\n\n\n.. image:: https://pepy.tech/badge/pyexcel-htmlr/month\n :target: https://pepy.tech/project/pyexcel-htmlr/month\n\n\n.. image:: https://img.shields.io/gitter/room/gitterHQ/gitter.svg\n :target: https://gitter.im/pyexcel/Lobby\n\n.. image:: https://readthedocs.org/projects/pyexcel-htmlr/badge/?version=latest\n :target: http://pyexcel-htmlr.readthedocs.org/en/latest/\n\n\nSupport the project\n================================================================================\n\nIf your company has embedded pyexcel and its components into a revenue generating\nproduct, please support me on github, `patreon <https://www.patreon.com/bePatron?u=5537627>`_\nor `bounty source <https://salt.bountysource.com/teams/chfw-pyexcel>`_ to maintain\nthe project and develop it further.\n\nIf you are an individual, you are welcome to support me too and for however long\nyou feel like. As my backer, you will receive\n`early access to pyexcel related contents <https://www.patreon.com/pyexcel/posts>`_.\n\nAnd your issues will get prioritized if you would like to become my patreon as `pyexcel pro user`.\n\nWith your financial support, I will be able to invest\na little bit more time in coding, documentation and writing interesting posts.\n\n\nKnown constraints\n==================\n\nFonts, colors and charts are not supported.\n\nInstallation\n================================================================================\n\n\nYou can install pyexcel-htmlr via pip:\n\n.. code-block:: bash\n\n $ pip install pyexcel-htmlr\n\n\nor clone it and install it:\n\n.. code-block:: bash\n\n $ git clone https://github.com/pyexcel/pyexcel-htmlr.git\n $ cd pyexcel-htmlr\n $ python setup.py install\n\nUsage\n================================================================================\n\nAs a standalone library\n--------------------------------------------------------------------------------\n\nRead from an html file\n********************************************************************************\n\nHere's the sample code:\n\n.. code-block:: python\n\n >>> from pyexcel_htmlr import get_data\n >>> data = get_data(\"your_file.html\")\n >>> import json\n >>> print(json.dumps(data))\n {\"Table 1\": [[1, 2, 3], [4, 5, 6]], \"Table 2\": [[\"row 1\", \"row 2\", \"row 3\"]]}\n\n\n\n\nRead from an html from memory\n********************************************************************************\n\nContinue from previous example:\n\n.. code-block:: python\n\n >>> # This is just an illustration\n >>> # In reality, you might deal with html file upload\n >>> # where you will read from requests.FILES['YOUR_HTML_FILE']\n >>> with open('your_file.html', 'r') as html_file:\n ... io = StringIO(html_file.read().encode())\n ... data = get_data(io)\n >>> print(json.dumps(data))\n {\"Table 1\": [[1, 2, 3], [4, 5, 6]], \"Table 2\": [[\"row 1\", \"row 2\", \"row 3\"]]}\n\nPagination feature\n********************************************************************************\n\n\n\nLet's assume the following file is a huge html file:\n\n.. code-block:: python\n\n >>> huge_data = [\n ... [1, 21, 31],\n ... [2, 22, 32],\n ... [3, 23, 33],\n ... [4, 24, 34],\n ... [5, 25, 35],\n ... [6, 26, 36]\n ... ]\n >>> sheetx = {\n ... \"Table 1\": huge_data\n ... }\n >>> pe.save_book_as(dest_file_name=\"huge_file.html\", bookdict=sheetx)\n\nAnd let's pretend to read partial data:\n\n.. code-block:: python\n\n >>> partial_data = get_data(\"huge_file.html\", start_row=2, row_limit=3)\n >>> print(json.dumps(partial_data))\n {\"Table 1\": [[3, 23, 33], [4, 24, 34], [5, 25, 35]]}\n\nAnd you could as well do the same for columns:\n\n.. code-block:: python\n\n >>> partial_data = get_data(\"huge_file.html\", start_column=1, column_limit=2)\n >>> print(json.dumps(partial_data))\n {\"Table 1\": [[21, 31], [22, 32], [23, 33], [24, 34], [25, 35], [26, 36]]}\n\nObvious, you could do both at the same time:\n\n.. code-block:: python\n\n >>> partial_data = get_data(\"huge_file.html\",\n ... start_row=2, row_limit=3,\n ... start_column=1, column_limit=2)\n >>> print(json.dumps(partial_data))\n {\"Table 1\": [[23, 33], [24, 34], [25, 35]]}\n\nAs a pyexcel plugin\n--------------------------------------------------------------------------------\n\nNo longer, explicit import is needed since pyexcel version 0.2.2. Instead,\nthis library is auto-loaded. So if you want to read data in html format,\ninstalling it is enough.\n\n\nReading from an html file\n********************************************************************************\n\nHere is the sample code:\n\n.. code-block:: python\n\n >>> import pyexcel as pe\n >>> sheet = pe.get_book(file_name=\"your_file.html\")\n >>> sheet\n Table 1:\n +---+---+---+\n | 1 | 2 | 3 |\n +---+---+---+\n | 4 | 5 | 6 |\n +---+---+---+\n Table 2:\n +-------+-------+-------+\n | row 1 | row 2 | row 3 |\n +-------+-------+-------+\n\n\n\n\nReading from a IO instance\n********************************************************************************\n\nYou got to wrap the binary content with stream to get html working:\n\n.. code-block:: python\n\n >>> # This is just an illustration\n >>> # In reality, you might deal with html file upload\n >>> # where you will read from requests.FILES['YOUR_HTML_FILE']\n >>> htmlfile = \"your_file.html\"\n >>> with open(htmlfile, \"rb\") as f:\n ... content = f.read()\n ... r = pe.get_book(file_type=\"html\", file_content=content)\n ... print(r)\n ...\n Table 1:\n +---+---+---+\n | 1 | 2 | 3 |\n +---+---+---+\n | 4 | 5 | 6 |\n +---+---+---+\n Table 2:\n +-------+-------+-------+\n | row 1 | row 2 | row 3 |\n +-------+-------+-------+\n\n\n\n\nLicense\n================================================================================\n\nNew BSD License\n\nDeveloper guide\n==================\n\nDevelopment steps for code changes\n\n#. git clone https://github.com/pyexcel/pyexcel-htmlr.git\n#. cd pyexcel-htmlr\n\nUpgrade your setup tools and pip. They are needed for development and testing only:\n\n#. pip install --upgrade setuptools pip\n\nThen install relevant development requirements:\n\n#. pip install -r rnd_requirements.txt # if such a file exists\n#. pip install -r requirements.txt\n#. pip install -r tests/requirements.txt\n\nOnce you have finished your changes, please provide test case(s), relevant documentation\nand update CHANGELOG.rst.\n\n.. note::\n\n As to rnd_requirements.txt, usually, it is created when a dependent\n library is not released. Once the dependecy is installed\n (will be released), the future\n version of the dependency in the requirements.txt will be valid.\n\n\nHow to test your contribution\n------------------------------\n\nAlthough `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.\n\nOn Linux/Unix systems, please launch your tests like this::\n\n $ make\n\nOn Windows systems, please issue this command::\n\n > test.bat\n\n\nBefore you commit\n------------------------------\n\nPlease run::\n\n $ make format\n\nso as to beautify your code otherwise travis-ci may fail your unit test.\n\n\nAnd make sure you would have run moban command\n---------------------------------------------------------\n\nAdditional steps are required:\n\n#. pip install moban\n#. make your changes in `.moban.d` directory, then issue command `moban`\n#. moban\n\notherwise travis-ci may also fail your unit test.\n\nWhat is .moban.d\n---------------------------------\n\n`.moban.d` stores the specific meta data for the library.\n\n\n\nChange log\n================================================================================\n\n0.6.0 - 9.10.2020\n--------------------------------------------------------------------------------\n\n**Updated**\n\n#. New style xlsx plugins, promoted by pyexcel-io v0.6.2\n\n0.5.2 - 23.10.2017\n--------------------------------------------------------------------------------\n\n**updated**\n\n#. pyexcel `pyexcel#105 <https://github.com/pyexcel/pyexcel/issues/105>`_,\n remove gease from setup_requires, introduced by 0.5.1.\n#. remove python2.6 test support\n#. update its dependecy on pyexcel-io to 0.5.3\n\n0.5.1 - 20.10.2017\n--------------------------------------------------------------------------------\n\n**added**\n\n#. `pyexcel#103 <https://github.com/pyexcel/pyexcel/issues/103>`_, include\n LICENSE file in MANIFEST.in, meaning LICENSE file will appear in the released\n tar ball.\n\n0.5.0 - 30.08.2017\n--------------------------------------------------------------------------------\n\n**Updated**\n\n#. put dependency on pyexcel-io 0.5.0, which uses cStringIO instead of StringIO.\n Hence, there will be performance boost in handling files in memory.\n#. version jumped because it will be easy to see pyexcel-htmlr depends on\n pyexcel-io v0.5.0\n\n**Relocated**\n\n#. type detection code is being relocated into pyexcel-io\n\n0.0.1 - 26-07-2017\n--------------------------------------------------------------------------------\n\n\n\n",
"bugtrack_url": null,
"license": "New BSD",
"summary": "read tables in html file as excel data",
"version": "0.6.0",
"split_keywords": [
"python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4c926113f017e460806552ba64eeafcd7f0829bc70f8d7fd203571712b53c22d",
"md5": "6ce310b6b2b4fd48882b50dc11e3940a",
"sha256": "4514273a10862b9c1949cc0eac945f9fb3cd5a1090ca2b4bd1bf534cdd65c36c"
},
"downloads": -1,
"filename": "pyexcel_htmlr-0.6.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "6ce310b6b2b4fd48882b50dc11e3940a",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.6",
"size": 8109,
"upload_time": "2020-10-08T22:25:06",
"upload_time_iso_8601": "2020-10-08T22:25:06.855230Z",
"url": "https://files.pythonhosted.org/packages/4c/92/6113f017e460806552ba64eeafcd7f0829bc70f8d7fd203571712b53c22d/pyexcel_htmlr-0.6.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "02bf535b3d5b9c6547d7e649f8efa98d5030954fe460db40d92ff3fb846743e5",
"md5": "c10c12efcd0165f7462987ce943f2c38",
"sha256": "5777860c4b961ac709e92a14b4e997e55b275edda6f2102eaf8581fd1481f771"
},
"downloads": -1,
"filename": "pyexcel-htmlr-0.6.0.tar.gz",
"has_sig": false,
"md5_digest": "c10c12efcd0165f7462987ce943f2c38",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 24559,
"upload_time": "2020-10-08T22:25:08",
"upload_time_iso_8601": "2020-10-08T22:25:08.296068Z",
"url": "https://files.pythonhosted.org/packages/02/bf/535b3d5b9c6547d7e649f8efa98d5030954fe460db40d92ff3fb846743e5/pyexcel-htmlr-0.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2020-10-08 22:25:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "pyexcel",
"github_project": "pyexcel-htmlr",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "pyexcel-htmlr"
}
JSON
