Home

Welcome to the stextools Wiki

stextools provides tools and a shared infrastructure for working with sTeX content.
This wiki documents details and usage.

Tools

• snify for large-scale term reference annotations
• clone-groups for mass-cloning archives (using ssh, not https)
• update-dependencies for updating archive dependencies (in MANIFEST.MF)
• cycle-finder for finding import cycles
• version prints the version of stextools

Installation

Warning: stextools is an actively developed research project and may not work as expected. Please report any issues.

Note that stextools is not tested on Windows.

Using pipx (recommended for most users)

First, install pipx (instructions). Then, run

pipx install git+https://github.com/slatex/stextools.git

This should install the stextools command line tool. You can try it out by running stextools --help.

You can update stextools with

pipx upgrade stextools

You can uninstall stextools

pipx uninstall stextools

Using pip (also provides stextools library, required for certain experimental features)

You can also install stextools using pip.

git clone https://github.com/jfschaefer/stextools.git
cd stextools
python3 -m pip install -e .

This enables you to use the stextools library in your own Python projects, and to run the command line tools.