Skip to content

ppizarror/PyDetex

Repository files navigation

PyDetex

@ppizarror

License MIT

Python 3.7+

PyPi package

FOSSA Status

Documentation Status

Codecov

Open issues

PyPi downloads

Total downloads

Buy me a Ko-fi

Source repo on GitHub, and run it on Repl.it

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:

$> 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.

$> python3 -m pydetex.gui

(Simple Pipeline) Tadada... !!! A simple GUI to process your LaTex, and paste it into Google Docs, an email, or Grammarly \(^o^)/

(Simple Pipeline) Tadada... !!! A simple GUI to process your LaTex, and paste it into Google Docs, an email, or Grammarly \(^o^)/

(Strict Pipeline) The strict pipeline removes all commands or replaces them with some known tags.

(Strict Pipeline) The strict pipeline removes all commands or replaces them with some known tags.

Multiple options to configure: Check repeated words, highlight undetected code, or use different pipelines.

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.

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.
  • Custom support for environments, such as table.

Author

Pablo Pizarro R. | 2021 - 2024