
Product
Socket Now Protects the Chrome Extension Ecosystem
Socket is launching experimental protection for Chrome extensions, scanning for malware and risky permissions to prevent silent supply chain attacks.
$ [sudo] pip install readme-md
<section-name>.md
sectionsreadme_md.Readme
#
headerReadme.order
or order.txt
setup.cfg
required) sections - install
, classes
, functions
, cli
readme_md.Readme
- README.md generator
Readme attrs | __doc__ |
---|---|
header_lvl | header default lvl (4) |
headers | dict with sections headers (optional) |
order | list of sections order |
sections | dict with sections (loaded from .md files) |
Readme methods | __doc__ |
---|---|
get_header(name) | return a string with section header |
get_section(name) | return a string with README section |
get_sections() | return all sections in a list of (name, string) pairs sorted by order |
load(path) | load sections and order |
render() | render to a string |
save(path='README.md') | save to file |
function | __doc__ |
---|---|
readme_md.broken_links(string, timeout=5) | return a list with broken markdown links |
readme_md.links(string) | return a list with markdown links |
readme_md.tables.attrs(cls) | return a string with class attributes table |
readme_md.tables.cls(cls) | return a string with class name, description and attrs+methods+properties tables |
readme_md.tables.methods(cls) | return a string with class methods table |
readme_md.tables.properties(cls) | return a string with class properties table |
readme_md.tables.usage(modules) | return a string with cli modules usage table. python -m module or module USAGE variable (if defined). if __name__ == "__main__" line required |
usage | __doc__ |
---|---|
python -m readme_md.broken_links path [timeout] | print README.md broken links |
python -m readme_md.create [path ...] | generate README.md |
python -m readme_md.links path | print README.md links |
# .README/examples.md, .README/features.md, .README/order.txt
$ python -m readme_md.create .README > README.md
$ python -m readme_md.broken_links README.md # find broken links
class Readme_npm(readme_md.Readme):
order = ["description","features","install", ...]
disabled = ["generator"]
@property
def install(self):
return "`$ [sudo] npm i -g %s`" % json.loads(path)["name"]
Readme(".README").save("README.md") # load sections and create README.md
readme-md - README.md generator
FAQs
README.md generator
We found that readme-md demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket is launching experimental protection for Chrome extensions, scanning for malware and risky permissions to prevent silent supply chain attacks.
Product
Add secure dependency scanning to Claude Desktop with Socket MCP, a one-click extension that keeps your coding conversations safe from malicious packages.
Product
Socket now supports Scala and Kotlin, bringing AI-powered threat detection to JVM projects with easy manifest generation and fast, accurate scans.