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.2.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.2-py3-none-any.whl (4.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: makereadme-0.0.2.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.2.tar.gz
Algorithm Hash digest
SHA256 2ab32000a777a294cbfa24a6a9b0488a54257285dd686c477a20b5e0d175e826
MD5 dd764957ae8e2001f8f051253c8e4947
BLAKE2b-256 a25bb20d4160cd00fcd6cdf033cbf482604a91bf433bc41f3b86e74e2588d713

See more details on using hashes here.

File details

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

File metadata

  • Download URL: makereadme-0.0.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 ad9fd7dc7cc3739debd3bf0d7db80ae9ccdc9355a9543bfcde3438b35dc6687e
MD5 f85e2d574e5c19ac9633f4c0e9dd3f3a
BLAKE2b-256 935027750db14d08d68bf751a8a45e99671700c0518b1635607fa94c0e541324

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