Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

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


Release history Release notifications

This version

0.1.0

Download files

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

Files for spellrst, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size spellrst-0.1.0-py3-none-any.whl (5.6 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size spellrst-0.1.0.tar.gz (4.3 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page