Metadata-Version: 2.4
Name: texact
Version: 0.1.0
Summary: Automated article and LaTeX checks
Author: Theodor Lindberg
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: Pillow>=10
Requires-Dist: colorama>=0.4
Provides-Extra: docs
Requires-Dist: sphinx>=7; extra == "docs"
Requires-Dist: furo>=2025; extra == "docs"
Requires-Dist: myst-parser>=4; extra == "docs"
Requires-Dist: m2r2; extra == "docs"
Requires-Dist: docutils<=0.20; extra == "docs"
Dynamic: license-file

# TeXact

TeXact is a tool for finding miscellaneous mistakes in LaTeX code
and article writing.
It does not edit your files, so you can run it fearlessly.
It is also not intended to replace existing tools, such as
[ChkTeX](https://www.nongnu.org/chktex/) and
[lacheck](https://linux.die.net/man/1/lacheck), but rather to
complement and incorporate them.

## Documentation

[https://theodor-lindberg.github.io/texact/](https://theodor-lindberg.github.io/texact/)

## Features

* Check consistency between "\ref" and "\label".
* Make sure certain words have correct casing.
* Warn if the abstract begins with "In this work" or similar.
* Avoid certain modal verbs, such as should, would, could, and might.
* Run [ChkTeX](https://www.nongnu.org/chktex/), if installed, with "appropriate"
settings.
* And more...

## Quickstart

TeXact can be installed using pip directly from git:

```bash
python -m pip install "git+ssh://git@github.com/Theodor-Lindberg/texact.git"
```

then run as

```bash
texact path/to/file.tex
```

For more information, run

```bash
texact -h
```
