https://github.com/alvinwan/texsoup
fault-tolerant Python3 package for searching, navigating, and modifying LaTeX documents
https://github.com/alvinwan/texsoup
document-tree latex latex-parser parser python python3
Last synced: 10 months ago
JSON representation
fault-tolerant Python3 package for searching, navigating, and modifying LaTeX documents
- Host: GitHub
- URL: https://github.com/alvinwan/texsoup
- Owner: alvinwan
- License: bsd-2-clause
- Created: 2016-04-02T10:29:06.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2025-02-10T11:33:11.000Z (12 months ago)
- Last Synced: 2025-04-12T19:50:05.864Z (10 months ago)
- Topics: document-tree, latex, latex-parser, parser, python, python3
- Language: Python
- Homepage: https://texsoup.alvinwan.com
- Size: 2.48 MB
- Stars: 301
- Watchers: 7
- Forks: 43
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [TexSoup](https://texsoup.alvinwan.com)
[](https://pypi.python.org/pypi/TexSoup/)
[](https://travis-ci.org/alvinwan/TexSoup)
[](https://coveralls.io/github/alvinwan/TexSoup?branch=master)
TexSoup is a fault-tolerant, Python3 package for searching, navigating, and modifying LaTeX documents. You can skip installation and try TexSoup directly, using the [pytwiddle demo →](https://pytwiddle.com/?id=example:latex.py)
- [Getting Started](https://github.com/alvinwan/TexSoup#Getting-Started)
- [Installation](https://github.com/alvinwan/TexSoup#Installation)
- [API Reference](http://texsoup.alvinwan.com/docs/data.html)
Created by [Alvin Wan](http://alvinwan.com) + [contributors](https://github.com/alvinwan/TexSoup/graphs/contributors).
# Getting Started
To parse a $LaTeX$ document, pass an open filehandle or a string into the
`TexSoup` constructor.
``` python
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.
```python
>>> 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]
```
For more use cases, see [the Quickstart Guide](https://texsoup.alvinwan.com/docs/quickstart.html). Or, try TexSoup [online, via pytwiddle →](https://pytwiddle.com/?id=example:latex.py)
Links:
- [Quickstart Guide: how and when to use TexSoup](http://texsoup.alvinwan.com/docs/quickstart.html)
- [Example Use Cases: counting references, resolving imports, and more](https://github.com/alvinwan/TexSoup/tree/master/examples)
# Installation
## Pip
TexSoup is published via PyPi, so you can install it via `pip`. The package
name is `TexSoup`:
```bash
$ pip install texsoup
```
## From source
Alternatively, you can install the package from source:
```bash
$ git clone https://github.com/alvinwan/TexSoup.git
$ cd TexSoup
$ pip install .
```