Skip to main content

mkreadme

PyPI version Python version Release Pipeline Code Quality License: MIT pre-commit

📝 Description

mkreadme is a cli tool for interactive creation of a README.md file. It was inspired by readme.so. You can choose from different README sections, which are then merged into a complete document.

⚙️ Installation

Install mkreadme with pip

  pip install mkreadme

💡 Usage Examples

To interactively create a README file with mkreadme, run

mkreadme --filename README.md

🖼️ Screenshots

App Screenshot

Metadata

Release files for mkreadme 0.4.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mkreadme 0.4.0
File Size Uploaded Provenance Actions
mkreadme-0.4.0.tar.gz 5.0 kB Without provenance Details for mkreadme-0.4.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for mkreadme 0.4.0
File Interpreter ABI Platform Actions
mkreadme-0.4.0-py3-none-any.whl Python 3 none any Details for mkreadme-0.4.0-py3-none-any.whl

Total release size: 10.4 kB

Release files / mkreadme-0.4.0.tar.gz

Download URL mkreadme-0.4.0.tar.gz
Size 5.0 kB
Tags Source
SHA-256 checksum
How to use checksums
b350afdbbbb5ebd8f11984bdde740d5eeda8e7fe544be9a797dcd598c630a5e1
BLAKE2b-256 checksum
How to use checksums
27bcd7fe35fc3b24895cba78ea6c86a326759f67de6fc04555737eec8c1b750b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.1.14 CPython/3.8.9 Linux/5.15.0-1014-azure

Release files / mkreadme-0.4.0-py3-none-any.whl

Download URL mkreadme-0.4.0-py3-none-any.whl
Size 5.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0259198bef28d9c22d20fb3b0c815b2284cf89cca579731a3cf32713c7494820
BLAKE2b-256 checksum
How to use checksums
a86b444bee6882a76d4e4d4312bf77bf14c9aad49935da3c51dc3991444ee2d8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.1.14 CPython/3.8.9 Linux/5.15.0-1014-azure

Security for mkreadme 0.4.0

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.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page