Metadata-Version: 2.1
Name: readme-docstring
Version: 2019.3.22
Summary: generate README from python docstrings
Home-page: https://github.com/looking-for-a-job/readme-docstring.py
License: UNKNOWN
Description: <!--
        https://pypi.org/project/readme-generator/
        -->
        
        [![](https://img.shields.io/pypi/pyversions/readme-docstring.svg?longCache=True)](https://pypi.org/project/readme-docstring/)
        
        #### Installation
        ```bash
        $ [sudo] pip install readme-docstring
        ```
        
        #### Classes
        class|`__doc__`
        -|-
        `readme_docstring.Classes` |`classes` table class. attrs: `classes`
        `readme_docstring.Functions` |`functions` table class. attrs: `functions`
        `readme_docstring.Table` |abstract table class. attrs: `headers`, `objects`
        
        #### Functions
        function|`__doc__`
        -|-
        `readme_docstring.getclasses()` |return a list of classes defined in `__all__`
        `readme_docstring.getdoc(obj)` |return first line of an object docstring
        `readme_docstring.getfunctions()` |return a list of functions defined in `__all__`
        `readme_docstring.getmembers()` |return all the members defined in `__all__` in a list of (name, value) pairs
        `readme_docstring.getmodules()` |return a list of modules
        `readme_docstring.getspec(routine)` |return a string with Python routine specification
        
        #### CLI
        usage|`__doc__`
        -|-
        `python -m readme_docstring.classes` |generate `classes` table
        `python -m readme_docstring.functions` |generate `functions` table
        
        #### Examples
        example with [readme-generator](https://pypi.org/project/readme-generator/)
        ```python
        class Readme(readme_generator.Readme):
            def classes(self):
                return readme_docstring.Classes()
        
            def functions(self):
                return readme_docstring.Functions()
        ```
        
        custom table
        ```python
        class Cli(readme_docstring.Table):
            columns = ["usage", "`__doc__`"]
        
            def __init__(self):
                self.objects = list(filter(lambda m: hasattr(m, "click"), setupcfg.getmodules()))
        
            def get_name(self, obj):
                default = "python -m %s" % obj.__name__.replace(".__main__", "")
                return "`%s`" % getattr(obj, "USAGE", default)
        ```
        
        #### Related projects
        +   [`classifiers-generator` - python classifiers generator](https://pypi.org/project/classifiers-generator/)
        +   [`commands-generator` - shell commands generator](https://pypi.org/project/commands-generator/)
        +   [`launchd-generator` - launchd.plist generator](https://pypi.org/project/launchd-generator/)
        +   [`readme-badges` - `README.md` badges](https://pypi.org/project/readme-badges/)
        +   [`readme-docstring` - generate README.md from python docstrings](https://pypi.org/project/readme-docstring/)
        +   [`readme-generator` - `README.md` generator](https://pypi.org/project/readme-generator/)
        +   [`setupcfg-generator` - `setup.cfg` generator](https://pypi.org/project/setupcfg-generator/)
        +   [`travis-generator` - `.travis.yml` generator](https://pypi.org/project/travis-generator/)
        
        <p align="center">
            <a href="https://pypi.org/project/readme-generator/">readme-generator</a>
        </p>
Keywords: readme docstring
Platform: UNKNOWN
Classifier: License :: Public Domain
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Software Development
Description-Content-Type: text/markdown
