Metadata-Version: 2.1
Name: TexSoup
Version: 0.3.1
Summary: parses valid LaTeX and provides variety of Beautiful-Soup-esque methods and Pythonic idioms for iterating over and searching the parse tree
Home-page: https://github.com/alvinwan/TexSoup
Author: Alvin Wan
Author-email: hi@alvinwan.com
License: BSD
Download-URL: https://github.com/alvinwan/TexSoup/archive/0.3.1.zip
Description: <a href="https://texsoup.alvinwan.com"><img src="https://user-images.githubusercontent.com/2068077/55692228-b7f92d00-595a-11e9-93a2-90090a361d12.png" width="80px"></a>
        
        # [TexSoup](https://texsoup.alvinwan.com)
        
        [![PyPi Downloads per Day](https://img.shields.io/pypi/dm/texsoup.svg)](https://pypi.python.org/pypi/TexSoup/)
        [![Build Status](https://travis-ci.org/alvinwan/TexSoup.svg?branch=master)](https://travis-ci.org/alvinwan/TexSoup)
        [![Coverage Status](https://coveralls.io/repos/github/alvinwan/TexSoup/badge.svg?branch=master)](https://coveralls.io/github/alvinwan/TexSoup?branch=master)
        
        TexSoup is a fault-tolerant, Python3 package for searching, navigating, and modifying LaTeX documents.
        
        - [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 repl.it &rarr;](https://repl.it/@ALVINWAN1/texsoup)
        
        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 .
        ```
        
Platform: UNKNOWN
Classifier: Topic :: Utilities
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Libraries
Description-Content-Type: text/markdown
