pylatexenc


Namepylatexenc JSON
Version 2.10 PyPI version JSON
download
home_pagehttps://github.com/phfaist/pylatexenc
SummarySimple LaTeX parser providing latex-to-unicode and unicode-to-latex conversion
upload_time2021-04-06 07:56:07
maintainer
docs_urlNone
authorPhilippe Faist
requires_python
licenseMIT
keywords latex text unicode encode parse expression
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            pylatexenc
==========

Simple LaTeX parser providing latex-to-unicode and unicode-to-latex conversion

.. image:: https://img.shields.io/github/license/phfaist/pylatexenc.svg?style=flat
   :target: https://github.com/phfaist/pylatexenc/blob/master/LICENSE.txt

.. image:: https://img.shields.io/travis/phfaist/pylatexenc.svg?style=flat
   :target: https://travis-ci.org/phfaist/pylatexenc
   
.. image:: https://img.shields.io/pypi/v/pylatexenc.svg?style=flat
   :target: https://pypi.org/project/pylatexenc/

.. image:: https://img.shields.io/lgtm/alerts/g/phfaist/pylatexenc.svg?logo=lgtm&logoWidth=18&style=flat
   :target: https://lgtm.com/projects/g/phfaist/pylatexenc/alerts/


Unicode Text to LaTeX code
--------------------------

The ``pylatexenc.latexencode`` module provides a function ``unicode_to_latex()``
which converts a unicode string into LaTeX text and escape sequences. It should
recognize accented characters and most math symbols. A couple of switches allow
you to alter how this function behaves.

You can also run ``latexencode`` in command-line to convert plain unicode text
(from the standard input or from files given on the command line) into LaTeX
code, written on to the standard output.

A third party plug-in for Vim
`vim-latexencode <https://github.com/Konfekt/vim-latexencode>`_
by `@Konfekt <https://github.com/Konfekt>`_
provides a corresponding command to operate on a given range.


Parsing LaTeX code & converting to plain text (unicode)
-------------------------------------------------------

The ``pylatexenc.latexwalker`` module provides a series of routines that parse
the LaTeX structure of given LaTeX code and returns a logical structure of
objects, which can then be used to produce output in another format such as
plain text.  This is not a replacement for a full (La)TeX engine, rather, this
module provides a way to parse a chunk of LaTeX code as mark-up code.

The ``pylatexenc.latex2text`` module builds up on top of
``pylatexenc.latexwalker`` and provides functions to convert given LaTeX code to
plain text with unicode characters.

You can also run ``latex2text`` in command-line to convert LaTeX input (either
from the standard input, or from files given on the command line) into plain
text written on the standard output.


Documentation
-------------

Full documentation is available at https://pylatexenc.readthedocs.io/.


License
-------

See LICENSE.txt (MIT License).

NOTE: See copyright notice and license information for file
``tools/unicode.xml`` provided in ``tools/unicode.xml.LICENSE``.  (The file
``tools/unicode.xml`` was downloaded from
https://www.w3.org/2003/entities/2007xml/unicode.xml as linked from
https://www.w3.org/TR/xml-entity-names/#source.)
            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/phfaist/pylatexenc",
    "name": "pylatexenc",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "latex text unicode encode parse expression",
    "author": "Philippe Faist",
    "author_email": "philippe.faist@bluewin.ch",
    "download_url": "https://files.pythonhosted.org/packages/5d/ab/34ec41718af73c00119d0351b7a2531d2ebddb51833a36448fc7b862be60/pylatexenc-2.10.tar.gz",
    "platform": "",
    "description": "pylatexenc\n==========\n\nSimple LaTeX parser providing latex-to-unicode and unicode-to-latex conversion\n\n.. image:: https://img.shields.io/github/license/phfaist/pylatexenc.svg?style=flat\n   :target: https://github.com/phfaist/pylatexenc/blob/master/LICENSE.txt\n\n.. image:: https://img.shields.io/travis/phfaist/pylatexenc.svg?style=flat\n   :target: https://travis-ci.org/phfaist/pylatexenc\n   \n.. image:: https://img.shields.io/pypi/v/pylatexenc.svg?style=flat\n   :target: https://pypi.org/project/pylatexenc/\n\n.. image:: https://img.shields.io/lgtm/alerts/g/phfaist/pylatexenc.svg?logo=lgtm&logoWidth=18&style=flat\n   :target: https://lgtm.com/projects/g/phfaist/pylatexenc/alerts/\n\n\nUnicode Text to LaTeX code\n--------------------------\n\nThe ``pylatexenc.latexencode`` module provides a function ``unicode_to_latex()``\nwhich converts a unicode string into LaTeX text and escape sequences. It should\nrecognize accented characters and most math symbols. A couple of switches allow\nyou to alter how this function behaves.\n\nYou can also run ``latexencode`` in command-line to convert plain unicode text\n(from the standard input or from files given on the command line) into LaTeX\ncode, written on to the standard output.\n\nA third party plug-in for Vim\n`vim-latexencode <https://github.com/Konfekt/vim-latexencode>`_\nby `@Konfekt <https://github.com/Konfekt>`_\nprovides a corresponding command to operate on a given range.\n\n\nParsing LaTeX code & converting to plain text (unicode)\n-------------------------------------------------------\n\nThe ``pylatexenc.latexwalker`` module provides a series of routines that parse\nthe LaTeX structure of given LaTeX code and returns a logical structure of\nobjects, which can then be used to produce output in another format such as\nplain text.  This is not a replacement for a full (La)TeX engine, rather, this\nmodule provides a way to parse a chunk of LaTeX code as mark-up code.\n\nThe ``pylatexenc.latex2text`` module builds up on top of\n``pylatexenc.latexwalker`` and provides functions to convert given LaTeX code to\nplain text with unicode characters.\n\nYou can also run ``latex2text`` in command-line to convert LaTeX input (either\nfrom the standard input, or from files given on the command line) into plain\ntext written on the standard output.\n\n\nDocumentation\n-------------\n\nFull documentation is available at https://pylatexenc.readthedocs.io/.\n\n\nLicense\n-------\n\nSee LICENSE.txt (MIT License).\n\nNOTE: See copyright notice and license information for file\n``tools/unicode.xml`` provided in ``tools/unicode.xml.LICENSE``.  (The file\n``tools/unicode.xml`` was downloaded from\nhttps://www.w3.org/2003/entities/2007xml/unicode.xml as linked from\nhttps://www.w3.org/TR/xml-entity-names/#source.)",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Simple LaTeX parser providing latex-to-unicode and unicode-to-latex conversion",
    "version": "2.10",
    "project_urls": {
        "Homepage": "https://github.com/phfaist/pylatexenc"
    },
    "split_keywords": [
        "latex",
        "text",
        "unicode",
        "encode",
        "parse",
        "expression"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5dab34ec41718af73c00119d0351b7a2531d2ebddb51833a36448fc7b862be60",
                "md5": "687e18d33ad765be7c93e87b9e459291",
                "sha256": "3dd8fd84eb46dc30bee1e23eaab8d8fb5a7f507347b23e5f38ad9675c84f40d3"
            },
            "downloads": -1,
            "filename": "pylatexenc-2.10.tar.gz",
            "has_sig": false,
            "md5_digest": "687e18d33ad765be7c93e87b9e459291",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 162597,
            "upload_time": "2021-04-06T07:56:07",
            "upload_time_iso_8601": "2021-04-06T07:56:07.854565Z",
            "url": "https://files.pythonhosted.org/packages/5d/ab/34ec41718af73c00119d0351b7a2531d2ebddb51833a36448fc7b862be60/pylatexenc-2.10.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2021-04-06 07:56:07",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "phfaist",
    "github_project": "pylatexenc",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "pylatexenc"
}
        
Elapsed time: 0.11239s