Metadata-Version: 2.1
Name: docstring-extractor
Version: 0.3.0
Summary: Get Python docstrings from files
Home-page: https://github.com/jkfran/docstring-extractor
License: GPL-3.0-or-later
Keywords: docstring,docstrings,parser
Author: Francisco Jimenez Cabrera
Author-email: jkfran@gmail.com
Requires-Python: >=3.6,<4.0
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: docstring-parser (>=0.7.2,<0.8.0)
Project-URL: Documentation, https://github.com/jkfran/docstring-extractor
Project-URL: Repository, https://github.com/jkfran/docstring-extractor
Description-Content-Type: text/markdown

# docstring-extractor

Get Python docstrings from files or Python source code.

Example usage:

```python
>>> from docstring_extractor import get_docstrings
>>>
>>> with open("example.py") as file:
...     get_docstrings(file)
...

{
    'module': 'example',
    'content': [{
        'type': 'Function',
        'name': 'my_fuction',
        'line': 4,
        'docstring': 'Long description spanning multiple lines\n- First line\n- Second line\n- Third line\n\n:param name: description 1\n:param int priority: description 2\n:param str sender: description 3\n:raises ValueError: if name is invalid'
    }]
}
```

# Contributing

This project uses [Black](https://github.com/psf/black).

