libtidy
=======
Python binding for the *libtidy* C library.
Overview
========
| Python |package_bold| module is a low-level binding for *libtidy* C library.
| It is an effort to allow python programs full access to the API implemented and
provided by the well known `*libtidy* <https://www.html-tidy.org/developer/>`__
library.
`PyPI record`_.
`Documentation`_.
| |package_bold| is a lightweight Python package, based on the *ctypes* library.
| It is fully compliant implementation of the original C *libtidy* API
by implementing whole its functionality in a clean Python instead of C.
|
| *libtidy* API documentation can be found at:
`libtidy API Reference <https://api.html-tidy.org/tidy/tidylib_api_next/>`__
|package_bold| uses the underlying *libtidy* C shared library as specified in
libtidy.cfg (included libtidy-X.X.* is the default), but there is also ability
to specify it programmatically by one of the following ways:
.. code:: python
import libtidy
libtidy.config(LIBTIDY="libtidy C shared library absolute path")
# or
libtidy.config(LIBTIDY=None) # included libtidy-X.X.* will be used
About original libtidy:
-----------------------
Borrowed from the `original website <https://www.html-tidy.org/developer/>`__:
**libtidy Introduction**
libtidy is the library version of `HTML Tidy <https://www.html-tidy.org/>`__.
In fact, Tidy is libtidy; the console application is a very simple C application
that links against libtidy. It's what powers Tidy, mod-tidy, and countless other
applications that perform tidying.
**Design factors**
libtidy is Thread Safe and Re-entrant. Because there are many uses for HTML
Tidy - from content validation, content scraping, conversion to XHTML -
it was important to make libtidy run reasonably well within server applications
as well as client side.
Requirements
============
- | It is a fully independent package.
| All necessary things are installed during the normal installation process.
- ATTENTION: currently works and tested only for Windows.
Installation
============
Prerequisites:
+ Python 3.9 or higher
* https://www.python.org/
* with C libtidy 5.9.14 is a primary test environment.
+ pip and setuptools
* https://pypi.org/project/pip/
* https://pypi.org/project/setuptools/
To install run:
.. parsed-literal::
python -m pip install --upgrade |package|
Development
===========
Prerequisites:
+ Development is strictly based on *tox*. To install it run::
python -m pip install --upgrade tox
Visit `Development page`_.
Installation from sources:
clone the sources:
.. parsed-literal::
git clone |respository| |package|
and run:
.. parsed-literal::
python -m pip install ./|package|
or on development mode:
.. parsed-literal::
python -m pip install --editable ./|package|
License
=======
| |copyright|
| Licensed under the HTML Tidy License
| https://spdx.org/licenses/HTMLTIDY.html
| Please refer to the accompanying LICENSE file.
Authors
=======
* Adam Karpierz <adam@karpierz.net>
.. |package| replace:: libtidy
.. |package_bold| replace:: **libtidy**
.. |copyright| replace:: Copyright (c) 2024-2024 Adam Karpierz
.. |respository| replace:: https://github.com/karpierz/libtidy.git
.. _Development page: https://github.com/karpierz/libtidy
.. _PyPI record: https://pypi.org/project/libtidy/
.. _Documentation: https://libtidy.readthedocs.io/
Changelog
=========
5.9.14a1 (2024-10-10)
---------------------
- First release.
0.0.0 (2024-10-10)
------------------
- Initial commit.
Raw data
{
"_id": null,
"home_page": null,
"name": "libtidy",
"maintainer": "Adam Karpierz",
"docs_url": null,
"requires_python": "<4.0.0,>=3.9.0",
"maintainer_email": "adam@karpierz.net",
"keywords": "tidy, libtidy, html, html5, xml",
"author": "Adam Karpierz",
"author_email": "adam@karpierz.net",
"download_url": "https://files.pythonhosted.org/packages/58/8d/3673b90f60ef2cd1d62895686c468a14dda1fd9513e0147ee1f317a84d9f/libtidy-5.9.14a1.zip",
"platform": "any",
"description": "libtidy\r\n=======\r\n\r\nPython binding for the *libtidy* C library.\r\n\r\nOverview\r\n========\r\n\r\n| Python |package_bold| module is a low-level binding for *libtidy* C library.\r\n| It is an effort to allow python programs full access to the API implemented and\r\n provided by the well known `*libtidy* <https://www.html-tidy.org/developer/>`__\r\n library.\r\n\r\n`PyPI record`_.\r\n\r\n`Documentation`_.\r\n\r\n| |package_bold| is a lightweight Python package, based on the *ctypes* library.\r\n| It is fully compliant implementation of the original C *libtidy* API\r\n by implementing whole its functionality in a clean Python instead of C.\r\n|\r\n| *libtidy* API documentation can be found at:\r\n\r\n `libtidy API Reference <https://api.html-tidy.org/tidy/tidylib_api_next/>`__\r\n\r\n|package_bold| uses the underlying *libtidy* C shared library as specified in\r\nlibtidy.cfg (included libtidy-X.X.* is the default), but there is also ability\r\nto specify it programmatically by one of the following ways:\r\n\r\n.. code:: python\r\n\r\n import libtidy\r\n libtidy.config(LIBTIDY=\"libtidy C shared library absolute path\")\r\n # or\r\n libtidy.config(LIBTIDY=None) # included libtidy-X.X.* will be used\r\n\r\nAbout original libtidy:\r\n-----------------------\r\n\r\nBorrowed from the `original website <https://www.html-tidy.org/developer/>`__:\r\n\r\n**libtidy Introduction**\r\n\r\nlibtidy is the library version of `HTML Tidy <https://www.html-tidy.org/>`__.\r\nIn fact, Tidy is libtidy; the console application is a very simple C application\r\nthat links against libtidy. It's what powers Tidy, mod-tidy, and countless other\r\napplications that perform tidying.\r\n\r\n**Design factors**\r\n\r\nlibtidy is Thread Safe and Re-entrant. Because there are many uses for HTML\r\nTidy - from content validation, content scraping, conversion to XHTML -\r\nit was important to make libtidy run reasonably well within server applications\r\nas well as client side.\r\n\r\nRequirements\r\n============\r\n\r\n- | It is a fully independent package.\r\n | All necessary things are installed during the normal installation process.\r\n- ATTENTION: currently works and tested only for Windows.\r\n\r\nInstallation\r\n============\r\n\r\nPrerequisites:\r\n\r\n+ Python 3.9 or higher\r\n\r\n * https://www.python.org/\r\n * with C libtidy 5.9.14 is a primary test environment.\r\n\r\n+ pip and setuptools\r\n\r\n * https://pypi.org/project/pip/\r\n * https://pypi.org/project/setuptools/\r\n\r\nTo install run:\r\n\r\n .. parsed-literal::\r\n\r\n python -m pip install --upgrade |package|\r\n\r\nDevelopment\r\n===========\r\n\r\nPrerequisites:\r\n\r\n+ Development is strictly based on *tox*. To install it run::\r\n\r\n python -m pip install --upgrade tox\r\n\r\nVisit `Development page`_.\r\n\r\nInstallation from sources:\r\n\r\nclone the sources:\r\n\r\n .. parsed-literal::\r\n\r\n git clone |respository| |package|\r\n\r\nand run:\r\n\r\n .. parsed-literal::\r\n\r\n python -m pip install ./|package|\r\n\r\nor on development mode:\r\n\r\n .. parsed-literal::\r\n\r\n python -m pip install --editable ./|package|\r\n\r\nLicense\r\n=======\r\n\r\n | |copyright|\r\n | Licensed under the HTML Tidy License\r\n | https://spdx.org/licenses/HTMLTIDY.html\r\n | Please refer to the accompanying LICENSE file.\r\n\r\nAuthors\r\n=======\r\n\r\n* Adam Karpierz <adam@karpierz.net>\r\n\r\n.. |package| replace:: libtidy\r\n.. |package_bold| replace:: **libtidy**\r\n.. |copyright| replace:: Copyright (c) 2024-2024 Adam Karpierz\r\n.. |respository| replace:: https://github.com/karpierz/libtidy.git\r\n.. _Development page: https://github.com/karpierz/libtidy\r\n.. _PyPI record: https://pypi.org/project/libtidy/\r\n.. _Documentation: https://libtidy.readthedocs.io/\r\n\r\nChangelog\r\n=========\r\n\r\n5.9.14a1 (2024-10-10)\r\n---------------------\r\n- First release.\r\n\r\n0.0.0 (2024-10-10)\r\n------------------\r\n- Initial commit.\r\n",
"bugtrack_url": null,
"license": "HTML Tidy License ; https://spdx.org/licenses/HTMLTIDY.html",
"summary": "Python binding for the libtidy C library.",
"version": "5.9.14a1",
"project_urls": {
"Documentation": "https://libtidy.readthedocs.io/",
"Download": "https://pypi.org/project/libtidy/",
"Homepage": "https://pypi.org/project/libtidy/",
"Issues": "https://github.com/karpierz/libtidy/issues",
"Source": "https://github.com/karpierz/libtidy"
},
"split_keywords": [
"tidy",
" libtidy",
" html",
" html5",
" xml"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "93646ebb5ae567f71c35ae0d3252def6eec765597d352289b9c8ffe1e079d588",
"md5": "8cea8b740f296bb4b73adf0e674e521a",
"sha256": "4c518a4a47f91255775ddf6c9c0052350ba6e7b482ec60cf3252d4b190d423a0"
},
"downloads": -1,
"filename": "libtidy-5.9.14a1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8cea8b740f296bb4b73adf0e674e521a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0.0,>=3.9.0",
"size": 596084,
"upload_time": "2024-10-12T23:18:25",
"upload_time_iso_8601": "2024-10-12T23:18:25.003783Z",
"url": "https://files.pythonhosted.org/packages/93/64/6ebb5ae567f71c35ae0d3252def6eec765597d352289b9c8ffe1e079d588/libtidy-5.9.14a1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "588d3673b90f60ef2cd1d62895686c468a14dda1fd9513e0147ee1f317a84d9f",
"md5": "a502b16b47485dc678185866a3a24621",
"sha256": "d169c12ad85a2cd19ec2858180d0228cadb1f832a97e1c156f366c924cf61d9d"
},
"downloads": -1,
"filename": "libtidy-5.9.14a1.zip",
"has_sig": false,
"md5_digest": "a502b16b47485dc678185866a3a24621",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0.0,>=3.9.0",
"size": 615034,
"upload_time": "2024-10-12T23:18:27",
"upload_time_iso_8601": "2024-10-12T23:18:27.894488Z",
"url": "https://files.pythonhosted.org/packages/58/8d/3673b90f60ef2cd1d62895686c468a14dda1fd9513e0147ee1f317a84d9f/libtidy-5.9.14a1.zip",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-12 23:18:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "karpierz",
"github_project": "libtidy",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "libtidy"
}
JSON
