restructuredtext-lint 0.3.1

reStructuredText linter

reStructuredText linter

This was created out of frustration with PyPI; it sucks finding out your reST is invalid after uploading it. It is being developed in junction with a Sublime Text linter.

Getting Started

Install the module with: pip install restructuredtext_lint

import restructuredtext_lint
errors = restructuredtext_lint.lint("""
Hello World
=======
""")

# `errors` will be list of system messages
# [<system_message: <paragraph...><literal_block...>>]
errors[0].message  # Title underline too short.

CLI Utility

For your convenience, we present a CLI utility rst-lint (also available as restructuredtext-lint).

$ rst-lint --help
usage: rst-lint [-h] [--format FORMAT] [--encoding ENCODING] filepath

Lint a reStructuredText file

positional arguments:
  filepath         File to lint

optional arguments:
  -h, --help            show this help message and exit
  --format FORMAT       Format of output (e.g. text, json)
  --encoding ENCODING   Encoding of the source file (e.g. utf-8)

$ rst-lint README.rst
WARNING README.rst:2 Title underline too short.

Documentation

restructuredtext-lint exposes a lint and lint_file function

restructuredtext_lint.lint(content, filepath=None)

Lint reStructuredText and return errors

• content String - reStructuredText to be linted

• filepath String - Optional path to file, this will be returned as the source

Returns:

• errors List - List of errors

  • Each error is a class from docutils with the following attrs

    • line Integer - Line where the error occurred

    • source String - filepath provided in parameters

    • level Integer - Level of the warning

      • Levels represent ‘info’: 1, ‘warning’: 2, ‘error’: 3, ‘severe’: 4

    • type String - Noun describing the error level

      • Levels can be ‘INFO’, ‘WARNING’, ‘ERROR’, or ‘SEVERE’

    • message String - Error message

    • full_message String - Error message and source lines where the error occurred

  • It should be noted that level, type, message, and full_message are custom attrs added onto the original system_message

restructuredtext_lint.lint_file(filepath, encoding=None)

Lint a reStructuredText file and return errors

• filepath String - Path to file for linting

• encoding String - Encoding to read file in as

  • When None is provided, it will use OS default as provided by locale.getpreferredencoding

  • The list of supported encodings can be found at http://docs.python.org/2/library/codecs.html#standard-encodings

Returns: Same structure as restructuredtext_lint.lint

Examples

Here is an example of all invalid properties

rst = """
Some content.

Hello World
=======
Some more content!
"""
errors = restructuredtext_lint.lint(rst, 'myfile.py')
errors[0].line  # 5
errors[0].source  # myfile.py
errors[0].level  # 2
errors[0].type  # WARNING
errors[0].message  # Title underline too short.
errors[0].full_message  # Title underline too short.
                        #
                        # Hello World
                        # =======

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Test via nosetests.

Donating

Support this project and others by twolfson via gittip.

Unlicense

As of Nov 22 2013, Todd Wolfson has released this repository and its contents to the public domain.

It has been released under the UNLICENSE.