Fork 0
pospell is a spellchecker for po files containing reStructuedText.
Go to file
Julien Palard 8b753bde26
FIX: Discrepancy between docutils rst and sphinx rst
:rfc: don't allow aliases in docutils implementation.

See: https://sourceforge.net/p/docutils/feature-requests/75/
2023-07-21 09:08:12 +02:00
.github Rename branch. 2021-11-26 10:38:50 +01:00
tests Tox and github actions. (#24) 2020-11-23 14:26:34 +01:00
.gitignore Git ignore file 2018-07-27 14:57:43 +02:00
.pre-commit-hooks.yaml Add pre-commit hook (#14) 2020-05-22 17:48:57 +02:00
.pylintrc Refactor pospell to use multiprocessing (#32) 2021-11-26 10:26:35 +01:00
CHANGELOG.md Bump to v1.0.12. 2021-04-10 00:12:33 +02:00
README.md Fix typo in README 2023-03-08 08:48:29 +01:00
pospell.py FIX: Discrepancy between docutils rst and sphinx rst 2023-07-21 09:08:12 +02:00
pyproject.toml FIX: Discrepancy between docutils rst and sphinx rst 2023-07-21 09:08:12 +02:00
tox.ini Bump Python versions used in tests. 2023-07-19 10:46:15 +02:00



pospell is a spellcheckers for po files containing reStructuredText.

Pospell is part of poutils!

Poutils (.po utils) is a metapackage to easily install useful Python tools to use with po files and pospell is a part of it! Go check out Poutils to discover the other tools!


By giving files to pospell:

$ pospell --language fr about.po

By using a bash expansion (note that we do not put quotes around *.po to let bash do its expansion):

$ pospell --language fr *.po

By using a glob pattern (note that we do put quotes around **/*.po to keep your shell from trying to expand it, we'll let Python do the expansion:

$ pospell --language fr --glob '**/*.po'


usage: pospell [-h] [-l LANGUAGE] [--glob GLOB] [--debug] [-p PERSONAL_DICT]
               [po_file [po_file ...]]

Check spelling in po files containing restructuredText.

positional arguments:
  po_file               Files to check, can optionally be mixed with --glob,
                        or not, use the one that fit your needs.

optional arguments:
  -h, --help            show this help message and exit
  -l LANGUAGE, --language LANGUAGE
                        Language to check, you'll have to install the
                        corresponding hunspell dictionary, on Debian see apt
                        list 'hunspell-*'.
  --glob GLOB           Provide a glob pattern, to be interpreted by pospell,
                        to find po files, like --glob '**/*.po'.
  -p PERSONAL_DICT, --personal-dict PERSONAL_DICT

A personal dict (the -p option) is simply a text file with one word per line.


You can work in a venv, to install the project locally:

python -m pip install .

And to test it locally:

python -m pip install tox
tox -p all