Skip to main content

A simple CLI tool to generate README.md files from Python scripts

Project description

mkreadme

mkreadme is a simple CLI tool to generate README.md files from Python scripts.


Installation

pip install mkreadme

Usage

mkreadme your_script.py

📄 LICENSE (MIT - inglês)


📄 LICENSE-PT (tradução)


📄 tests/test_basic.py

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

makereadme-0.0.1.tar.gz (3.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

makereadme-0.0.1-py3-none-any.whl (4.6 kB view details)

Uploaded Python 3

File details

Details for the file makereadme-0.0.1.tar.gz.

File metadata

  • Download URL: makereadme-0.0.1.tar.gz
  • Upload date:
  • Size: 3.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for makereadme-0.0.1.tar.gz
Algorithm Hash digest
SHA256 800fecdc087b0c8a51b5e2587d2116ef2476edd45e50479fa0b0061de09cc9f3
MD5 da2319316886709905f00e64a6beeec3
BLAKE2b-256 09d08283f58f7438004ff0c2d38a809f8d868b799a3a1e916fed305a81ce3e48

See more details on using hashes here.

File details

Details for the file makereadme-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: makereadme-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 4.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for makereadme-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1c1a8ba5d5d2a3d6fb0cb4029cebfadd5705c40d2c28256b9c2e3841e7b19f41
MD5 96f38acc79fa25a8ab79dd5a7ccd2fc2
BLAKE2b-256 88a0e3a774fab04ef1240cb0c2bbe4dbeea9c6ed9a56877fa42a91fdb0bc573c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page