Thanks to visit codestin.com
Credit goes to github.com

Skip to content
forked from alvinwan/TexSoup

Python3 package for searching, navigating, and modifying LaTeX documents using BeautifulSoup-esque idioms

License

Notifications You must be signed in to change notification settings

mrakitin/TexSoup

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Build Status Coverage Status

TexSoup is a Python3 package for searching, navigating, and modifying LaTeX documents.

Created by Alvin Wan.

Installation

Pip

TexSoup is published via PyPi, so you can install it via pip. The package name is TexSoup:

$ pip install texsoup

From source

Alternatively, you can install the package from source:

$ git clone https://github.com/alvinwan/TexSoup.git
$ cd TexSoup
$ pip install .

Getting Started

There is one main utility, TexSoup, which translates any $\LaTeX$ string or iterator into a soupified object.

Basic Usage

There are two ways to input $\LaTeX$ into TexSoup. Either pass in (1) a file buffer (open('file.tex')) or (2) a string.

from TexSoup import TexSoup
soup = TexSoup("""
\begin{document}

\section{Hello \textit{world}.}

\subsection{Watermelon}

(n.) A sacred fruit. Also known as:

\begin{itemize}
\item red lemon
\item life
\end{itemize}

Here is the prevalence of each synonym.

\begin{tabular}{c c}
red lemon & uncommon \\
life & common
\end{tabular}

\end{document}
""")

With the soupified $\LaTeX$, you can now search and traverse the document tree. The code below demonstrates the basic functions that TexSoup provides.

>>> soup.section  # grabs the first `section`
\section{Hello \textit{world}.}
>>> soup.section.name
'section'
>>> soup.section.string
'Hello \\textit{world}.'
>>> soup.section.parent.name
'document'
>>> soup.tabular
\begin{tabular}{c c}
red lemon & uncommon \\
life & common
\end{tabular}
>>> soup.tabular.args[0]
'c c'
>>> soup.item
\item red lemon
>>> list(soup.find_all('item'))
[\item red lemon, \item life]

See more in the Quickstart Guide →

About

Python3 package for searching, navigating, and modifying LaTeX documents using BeautifulSoup-esque idioms

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 99.5%
  • TeX 0.5%