Skip to main content

README CLI

Simple README.md generator.

Installation

To install type the following in the terminal:

pip install readme-cli

Usage

Command to generate LICENSE.md file looks like:

readme

Or you can specify a variant of the generated README.md:

readme <readme-variant>

Where <readme-variant> is one of:

  • small - title, installation, usage
  • medium - title, installation, usage, license, contributing
  • large - lots of stuff

License

MIT

Contributing

See CONTRIBUTING.md

Metadata

Release files for readme-cli 1.0.1

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

Source distribution (sdist)

Source distribution for readme-cli 1.0.1
File Size Uploaded Provenance Actions
readme-cli-1.0.1.tar.gz 3.8 kB Without provenance Details for readme-cli-1.0.1.tar.gz

Release files / readme-cli-1.0.1.tar.gz

Download URL readme-cli-1.0.1.tar.gz
Size 3.8 kB
Tags Source
SHA-256 checksum
How to use checksums
9aa23d4ff6d5a8b775dc01802a3f8072c6c9d94bdbe83420f117c61e0bf1b137
BLAKE2b-256 checksum
How to use checksums
ecc37b3302882781b43ca1212e73f68a11972575d3b24696363ca15b2676457e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.4.2 requests/2.21.0 setuptools/41.4.0 requests-toolbelt/0.8.0 tqdm/4.36.1 CPython/3.7.3

Security for readme-cli 1.0.1

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.

Release history Release notifications | RSS feed

This release

1.0.1 This release

1 release file No provenance

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