Install
$ [sudo] pip install readme-md
Features
<section-name>.mdsections- attrs/properties/methods sections - subclass
readme_md.Readme - auto headers - if section 1st line is not empty and not
#header - sections order -
Readme.orderororder.txt - python project (
setup.cfgrequired) sections -install,classes,functions,cli
Classes
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 |
Functions
| 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 |
CLI
| 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 |
Examples
# .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
2 maintainers
Metadata
2 maintainers
Release files for readme-md 2019.1.28
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| readme-md-2019.1.28.tar.gz | 5.4 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| readme_md-2019.1.28-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details |
Total release size: 13.1 kB
Release files / readme-md-2019.1.28.tar.gz
| Download URL | readme-md-2019.1.28.tar.gz |
|---|---|
| Size | 5.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
01492f210443fa37a0b34e051ae24ca23e4a92f0f39ef03b5c02cf09d76df455
|
|
BLAKE2b-256 checksum How to use checksums |
85ab4e409d4a2afb85829b72380a6e2b59b3f9813c7f89cb273e88e9df3329ce
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.2
|
Release files / readme_md-2019.1.28-py2.py3-none-any.whl
| Download URL | readme_md-2019.1.28-py2.py3-none-any.whl |
|---|---|
| Size | 7.7 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
687b2799d9e1297f018b71a2fb4aaa22b2e23de4bf30b2b7ee4f457fcef8247f
|
|
BLAKE2b-256 checksum How to use checksums |
26241d3ff61664359cc6f72b8dcaed5ac2c4458e211e42c2226573646d29cc58
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.2
|
Security for readme-md 2019.1.28
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
