=======
PyDetex
=======
.. image:: https://img.shields.io/badge/author-Pablo%20Pizarro%20R.-lightgray.svg
:target: https://ppizarror.com
:alt: @ppizarror
.. image:: https://img.shields.io/badge/license-MIT-blue.svg
:target: https://opensource.org/licenses/MIT
:alt: License MIT
.. image:: https://img.shields.io/badge/python-3.7+-red.svg
:target: https://www.python.org/downloads
:alt: Python 3.7+
.. image:: https://badge.fury.io/py/pydetex.svg
:target: https://pypi.org/project/pydetex
:alt: PyPi package
.. image:: https://img.shields.io/github/actions/workflow/status/ppizarror/PyDetex/ci.yml?branch=master
:target: https://github.com/ppizarror/PyDetex/actions/workflows/ci.yml
:alt: Build status
.. image:: https://app.fossa.com/api/projects/git%2Bgithub.com%2Fppizarror%2FPyDetex.svg?type=shield
:target: https://app.fossa.com/projects/git%2Bgithub.com%2Fppizarror%2FPyDetex?ref=badge_shield
:alt: FOSSA Status
.. image:: https://readthedocs.org/projects/pydetex/badge/?version=latest
:target: https://pydetex.readthedocs.io
:alt: Documentation Status
.. image:: https://codecov.io/gh/ppizarror/PyDetex/branch/master/graph/badge.svg
:target: https://codecov.io/gh/ppizarror/PyDetex
:alt: Codecov
.. image:: https://img.shields.io/github/issues/ppizarror/PyDetex
:target: https://github.com/ppizarror/PyDetex/issues
:alt: Open issues
.. image:: https://img.shields.io/pypi/dm/pydetex?color=purple
:target: https://pypi.org/project/pydetex
:alt: PyPi downloads
.. image:: https://static.pepy.tech/personalized-badge/pydetex?period=total&units=international_system&left_color=grey&right_color=lightgrey&left_text=total%20downloads
:target: https://pepy.tech/project/pydetex
:alt: Total downloads
.. image:: https://img.shields.io/badge/buy%20me%20a-Ko--fi-02b9fe
:target: https://ko-fi.com/ppizarror
:alt: Buy me a Ko-fi
Source repo on `GitHub <https://github.com/ppizarror/PyDetex>`_,
and run it on `Repl.it <https://repl.it/github/ppizarror/PyDetex>`_
Introduction
------------
PyDetex is a Python application that transforms LaTeX code to plain text. It has multiple
language support (15+), detects repeated words, offers a dictionary (synonyms, antonyms,
definitions), and many things more to come!
Comprehensive documentation for the latest version (if you plan to use the API)
is available at https://pydetex.readthedocs.io
Install Instructions
--------------------
PyDetex can be installed via pip, for both MacOS, Windows & Linux. Simply run:
.. code-block:: bash
$> python3 pip install pydetex -U
Also, there're compiled binaries for Windows (x64) and macOS available through GitHub releases.
Launch the GUI, or use the library
----------------------------------
Simply run this command anywhere to execute the application.
.. code-block:: bash
$> python3 -m pydetex.gui
.. figure:: https://raw.githubusercontent.com/ppizarror/pydetex/master/docs/_static/example_simple.png
:scale: 40%
:align: center
**(Simple Pipeline)** Tadada... !!! A simple GUI to process your LaTex, and paste into Google Docs, an email, or Grammarly ＼(^o^)／
.. figure:: https://raw.githubusercontent.com/ppizarror/pydetex/master/docs/_static/example_strict.png
:scale: 40%
:align: center
**(Strict Pipeline)** The strict pipeline removes all commands, or replaces by some known tags.
.. figure:: https://raw.githubusercontent.com/ppizarror/pydetex/master/docs/_static/pydetex_windows.png
:scale: 40%
:align: center
Multiple options to configure: Check repeated words, highlight undetected code, or use different pipelines.
You can also import the library, and use the parsers (methods that take latex code
and perform a single task) or the pipelines (combination of parsers). For more
information, visit the `documentation <https://pydetex.readthedocs.io>`_.
.. code-block:: python
import pydetex.pipelines as pip
text = "This is a \\textbf{LaTex} code..."
out = pip.simple(text)
TO-DOs
------
Currently, many things must be improved:
- Add synthax checking for several languages, like `language-check <https://github.com/myint/language-check>`_.
- Custom support for environments, such as *table*.
Author
------
`Pablo Pizarro R. <https://ppizarror.com>`_ | 2021 - 2023
Raw data
{
"_id": null,
"home_page": "https://pydetex.readthedocs.io",
"name": "pydetex",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7, <4",
"maintainer_email": "",
"keywords": "latex detex parser gui",
"author": "Pablo Pizarro R.",
"author_email": "pablo@ppizarror.com",
"download_url": "https://files.pythonhosted.org/packages/d2/9b/46bf6f3f0a4b27dcb47b36d8396b4a010790a57697a8ff7bda9d9bbacd8f/pydetex-1.0.8.tar.gz",
"platform": "any",
"description": "=======\nPyDetex\n=======\n\n.. image:: https://img.shields.io/badge/author-Pablo%20Pizarro%20R.-lightgray.svg\n :target: https://ppizarror.com\n :alt: @ppizarror\n\n.. image:: https://img.shields.io/badge/license-MIT-blue.svg\n :target: https://opensource.org/licenses/MIT\n :alt: License MIT\n\n.. image:: https://img.shields.io/badge/python-3.7+-red.svg\n :target: https://www.python.org/downloads\n :alt: Python 3.7+\n\n.. image:: https://badge.fury.io/py/pydetex.svg\n :target: https://pypi.org/project/pydetex\n :alt: PyPi package\n\n.. image:: https://img.shields.io/github/actions/workflow/status/ppizarror/PyDetex/ci.yml?branch=master\n :target: https://github.com/ppizarror/PyDetex/actions/workflows/ci.yml\n :alt: Build status\n \n.. image:: https://app.fossa.com/api/projects/git%2Bgithub.com%2Fppizarror%2FPyDetex.svg?type=shield\n :target: https://app.fossa.com/projects/git%2Bgithub.com%2Fppizarror%2FPyDetex?ref=badge_shield\n :alt: FOSSA Status\n \n.. image:: https://readthedocs.org/projects/pydetex/badge/?version=latest\n :target: https://pydetex.readthedocs.io\n :alt: Documentation Status\n\n.. image:: https://codecov.io/gh/ppizarror/PyDetex/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/ppizarror/PyDetex\n :alt: Codecov\n\n.. image:: https://img.shields.io/github/issues/ppizarror/PyDetex\n :target: https://github.com/ppizarror/PyDetex/issues\n :alt: Open issues\n\n.. image:: https://img.shields.io/pypi/dm/pydetex?color=purple\n :target: https://pypi.org/project/pydetex\n :alt: PyPi downloads\n\n.. image:: https://static.pepy.tech/personalized-badge/pydetex?period=total&units=international_system&left_color=grey&right_color=lightgrey&left_text=total%20downloads\n :target: https://pepy.tech/project/pydetex\n :alt: Total downloads\n \n.. image:: https://img.shields.io/badge/buy%20me%20a-Ko--fi-02b9fe\n :target: https://ko-fi.com/ppizarror\n :alt: Buy me a Ko-fi\n\nSource repo on `GitHub <https://github.com/ppizarror/PyDetex>`_, \nand run it on `Repl.it <https://repl.it/github/ppizarror/PyDetex>`_\n\nIntroduction\n------------\n\nPyDetex is a Python application that transforms LaTeX code to plain text. It has multiple\nlanguage support (15+), detects repeated words, offers a dictionary (synonyms, antonyms,\ndefinitions), and many things more to come!\n\nComprehensive documentation for the latest version (if you plan to use the API)\nis available at https://pydetex.readthedocs.io\n\nInstall Instructions\n--------------------\n\nPyDetex can be installed via pip, for both MacOS, Windows & Linux. Simply run:\n\n.. code-block:: bash\n\n $> python3 pip install pydetex -U\n\nAlso, there're compiled binaries for Windows (x64) and macOS available through GitHub releases.\n\nLaunch the GUI, or use the library\n----------------------------------\n\nSimply run this command anywhere to execute the application.\n\n.. code-block:: bash\n\n $> python3 -m pydetex.gui\n\n.. figure:: https://raw.githubusercontent.com/ppizarror/pydetex/master/docs/_static/example_simple.png\n :scale: 40%\n :align: center\n\n **(Simple Pipeline)** Tadada... !!! A simple GUI to process your LaTex, and paste into Google Docs, an email, or Grammarly \uff3c(^o^)\uff0f\n\n.. figure:: https://raw.githubusercontent.com/ppizarror/pydetex/master/docs/_static/example_strict.png\n :scale: 40%\n :align: center\n\n **(Strict Pipeline)** The strict pipeline removes all commands, or replaces by some known tags.\n \n\n.. figure:: https://raw.githubusercontent.com/ppizarror/pydetex/master/docs/_static/pydetex_windows.png\n :scale: 40%\n :align: center\n\n Multiple options to configure: Check repeated words, highlight undetected code, or use different pipelines.\n\nYou can also import the library, and use the parsers (methods that take latex code\nand perform a single task) or the pipelines (combination of parsers). For more\ninformation, visit the `documentation <https://pydetex.readthedocs.io>`_.\n\n.. code-block:: python\n\n import pydetex.pipelines as pip\n text = \"This is a \\\\textbf{LaTex} code...\"\n out = pip.simple(text)\n\nTO-DOs\n------\n\nCurrently, many things must be improved:\n\n- Add synthax checking for several languages, like `language-check <https://github.com/myint/language-check>`_.\n- Custom support for environments, such as *table*.\n\nAuthor\n------\n\n`Pablo Pizarro R. <https://ppizarror.com>`_ | 2021 - 2023\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "An application that transforms LaTeX code to plain text",
"version": "1.0.8",
"project_urls": {
"Bug Tracker": "https://github.com/ppizarror/PyDetex/issues",
"Documentation": "https://pydetex.readthedocs.io",
"Homepage": "https://pydetex.readthedocs.io",
"Source Code": "https://github.com/ppizarror/PyDetex"
},
"split_keywords": [
"latex",
"detex",
"parser",
"gui"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9234ed55505d4d7df9cd060b6bbda662a645d67162848352d99d6af1383d3de1",
"md5": "0104821c024e1ac1815dcb68775663bc",
"sha256": "5ec5bf5a3764184be22480d363763dab4a652eea04b9272c79d9f526a8490274"
},
"downloads": -1,
"filename": "pydetex-1.0.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0104821c024e1ac1815dcb68775663bc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7, <4",
"size": 129985,
"upload_time": "2023-11-28T02:38:19",
"upload_time_iso_8601": "2023-11-28T02:38:19.408779Z",
"url": "https://files.pythonhosted.org/packages/92/34/ed55505d4d7df9cd060b6bbda662a645d67162848352d99d6af1383d3de1/pydetex-1.0.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d29b46bf6f3f0a4b27dcb47b36d8396b4a010790a57697a8ff7bda9d9bbacd8f",
"md5": "f55c9729e6369cd7bba98a4601234354",
"sha256": "ff0f6b1477f0cef201345385d3e8c7dda7bbc5644e7107774797d0482b140031"
},
"downloads": -1,
"filename": "pydetex-1.0.8.tar.gz",
"has_sig": false,
"md5_digest": "f55c9729e6369cd7bba98a4601234354",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7, <4",
"size": 126534,
"upload_time": "2023-11-28T02:38:21",
"upload_time_iso_8601": "2023-11-28T02:38:21.724038Z",
"url": "https://files.pythonhosted.org/packages/d2/9b/46bf6f3f0a4b27dcb47b36d8396b4a010790a57697a8ff7bda9d9bbacd8f/pydetex-1.0.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-28 02:38:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ppizarror",
"github_project": "PyDetex",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "pydetex"
}
JSON
