https://github.com/andrewpetrochenkov/readme-docstring.py

:book: generate README from python docstrings
https://github.com/andrewpetrochenkov/readme-docstring.py

cli python readme

Last synced: 7 months ago
JSON representation

:book: generate README from python docstrings

• Host: GitHub
• URL: https://github.com/andrewpetrochenkov/readme-docstring.py
• Owner: andrewpetrochenkov
• License: unlicense
• Created: 2019-03-08T20:53:49.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2020-12-03T21:20:18.000Z (about 5 years ago)
• Last Synced: 2025-05-31T22:42:03.537Z (7 months ago)
• Topics: cli, python, readme
• Language: Python
• Homepage:
• Size: 7.81 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          


[![](https://img.shields.io/pypi/v/readme-docstring.svg?maxAge=3600)](https://pypi.org/project/readme-docstring/)

[![](https://img.shields.io/badge/License-Unlicense-blue.svg?longCache=True)](https://unlicense.org/)

[![](https://github.com/andrewp-as-is/readme-docstring.py/workflows/tests42/badge.svg)](https://github.com/andrewp-as-is/readme-docstring.py/actions)

### Installation

```bash

$ [sudo] pip install readme-docstring

```

#### Examples

example with [readme-generator](https://pypi.org/project/readme-generator/)

```python

class Readme(readme_generator.Readme):

    order = [..., "classes", "functions", ...]

    def classes(self):

        classes = self.getclasses()

        return readme_docstring.Classes(classes)

    def functions(self):

        functions = self.getfunctions()

        return readme_docstring.Functions(functions)

```

custom table

```python

class ExecutableModules(readme_docstring.Table):

    columns = ["usage", "`__doc__`"]

    def __init__(self,modules):

        self.objects = modules

    def getleftcell(self, obj):

        default = "python -m %s" % obj.__name__.replace(".__main__", "")

        return "`%s`" % getattr(obj, "USAGE", default)

```



    readme42.com