Skip to content

Latest commit

 

History

History
127 lines (86 loc) · 4.28 KB

README.rst

File metadata and controls

127 lines (86 loc) · 4.28 KB
Raw

PyDetex

@ppizarror License MIT Python 3.7+ PyPi package Build status 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 more things 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 MacOS, Windows & Linux. Simply run:

$> python3 pip install pydetex -U

Also, compiled binaries for Windows (x64) and macOS are available through GitHub releases.

Launch the GUI or use the library

You can just run this command anywhere to execute the application.

$> python3 -m pydetex.gui
https://raw.githubusercontent.com/ppizarror/pydetex/master/docs/_static/example_simple.png

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

https://raw.githubusercontent.com/ppizarror/pydetex/master/docs/_static/example_strict.png

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

https://raw.githubusercontent.com/ppizarror/pydetex/master/docs/_static/pydetex_windows.png

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