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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file spellrst-0.1.0.tar.gz.

File metadata

  • Download URL: spellrst-0.1.0.tar.gz
  • Upload date:
  • Size: 4.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.22.0

File hashes

Hashes for spellrst-0.1.0.tar.gz
Algorithm Hash digest
SHA256 4d9d11e265ec56a15672239f2a40839d03c826a98d4afd97be71f9ee2b62a7da
MD5 29d1c4a5baa3a531ed8553a08decd236
BLAKE2b-256 a956a7214dc6279551c5abdf53c6302af9602c5fa9e62eeeaf787a339a344162

See more details on using hashes here.

File details

Details for the file spellrst-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: spellrst-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 5.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.22.0

File hashes

Hashes for spellrst-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2361d5292debc064e98993da84dcd9be1e80718f4677cac7647c7635e7aae781
MD5 67f76ecf24d76840832bf87bbc391521
BLAKE2b-256 edd6107bae8a5045801b9fe9ecfa4c2eb832796d589d22b6f3df6f29b6399af2

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page