Skip to main content

Spell check reStructuredText.

Project description

Spell check reStructuredText.

Install

Install with pip:

pip install spellrst

And download the spaCy model you want to use e.g. en_core_web_md:

python -m spacy download en_core_web_md

Usage

After installing you can run spellrst from the command line:

$ spellrst --help
Usage: spellrst [OPTIONS] [FILES]...

  Spell check reStructuredText.

Options:
  -d, --dictionary TEXT  spaCy language model (spacy.io/models), e.g.
                         en_core_web_md
  --help                 Show this message and exit.

For example, to check all rst files contained in a directory (fish):

spellrst **.rst

TODO

  • whitelist

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

spellrst-0.1.0.tar.gz (4.3 kB view hashes)

Uploaded source

Built Distribution

spellrst-0.1.0-py3-none-any.whl (5.6 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page