Metadata-Version: 2.1
Name: docstring-parser
Version: 0.8.1
Summary: "Parse Python docstrings in reST, Google and Numpydoc format"
Home-page: https://github.com/rr-/docstring_parser
Author: Marcin Kurczewski
Author-email: rr-@sakuya.pl
License: MIT
Description: docstring_parser
        ================
        
        Parse Python docstrings. Currently support ReST, Google, and Numpydoc-style
        docstrings.
        
        Example usage:
        
        ```python
        >>> from docstring_parser import parse
        >>>
        >>>
        >>> docstring = parse(
        ...     '''
        ...     Short description
        ...
        ...     Long description spanning multiple lines
        ...     - First line
        ...     - Second line
        ...     - Third line
        ...
        ...     :param name: description 1
        ...     :param int priority: description 2
        ...     :param str sender: description 3
        ...     :raises ValueError: if name is invalid
        ...     ''')
        >>>
        >>> docstring.long_description
        'Long description spanning multiple lines\n- First line\n- Second line\n- Third line'
        >>> docstring.params[1].arg_name
        'priority'
        >>> docstring.raises[0].type_name
        'ValueError'
        ```
        
        # Contributing
        
        This project uses [Black](https://github.com/psf/black) with `-l79` setting as
        well as [isort](https://github.com/timothycrosley/isort).
        
Platform: UNKNOWN
Classifier: Environment :: Other Environment
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Text Processing :: Markup
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.5
Description-Content-Type: text/markdown
