Metadata-Version: 1.1
Name: restructuredtext-lint
Version: 0.2.0
Summary: reStructuredText linter
Home-page: https://github.com/twolfson/restructuredtext-lint
Author: Todd Wolfson
Author-email: todd@twolfson.com
License: UNLICENSE
Download-URL: https://github.com/twolfson/restructuredtext-lint/archive/master.zip
Description: restructuredtext-lint
        =====================
        
        .. image:: https://travis-ci.org/twolfson/restructuredtext-lint.png?branch=master
           :target: https://travis-ci.org/twolfson/restructuredtext-lint
           :alt: Build Status
        
        `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.
        
        .. _`reStructuredText`: http://docutils.sourceforge.net/rst.html
        .. _`linter`: http://en.wikipedia.org/wiki/Lint_%28software%29
        .. _`reST`: `reStructuredText`_
        .. _`PyPI`: http://pypi.python.org/
        .. _`Sublime Text`: http://sublimetext.com/
        
        Getting Started
        ---------------
        Install the module with: ``pip install restructuredtext_lint``
        
        .. code:: python
        
            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``).
        
        .. code:: bash
        
            $ rst-lint --help
            usage: rst-lint [-h] [--format FORMAT] 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)
        
            $ rst-lint README.rst
            WARNING README.rst:2 Title underline too short.
        
        Documentation
        -------------
        ``restructuredtext-lint`` exposes a ``lint`` 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``
        
        .. _`docutils`: http://docutils.sourceforge.net/
        
        Examples
        --------
        Here is an example of all invalid properties
        
        .. code:: python
        
            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`_.
        
        .. image:: https://rawgithub.com/twolfson/gittip-badge/master/dist/gittip.png
           :target: `gittip`_
           :alt: Support via Gittip
        
        .. _`others by twolfson`:
        .. _gittip: https://www.gittip.com/twolfson/
        
        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`_.
        
        .. _UNLICENSE: https://github.com/twolfson/restructuredtext-lint/blob/master/UNLICENSE
        
Keywords: restructuredtext,restructured text,rest,rst,lint
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: Public Domain
Classifier: Operating System :: OS Independent
Classifier: Topic :: Text Processing :: Markup
