======= 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 into 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 it 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 them with 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 (a combination of parsers). For more information, please 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 syntax 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 - 2024