Skip to main content

Autogenerates pretty Makefile help

Project description

Makefile help

This small package helps by generating colourful help for Makefiles.


Why?

I often store useful commands in Makefiles and then promptly forget them.


Usage

At the top of a Makefile add the following (assuming makefile-help is installed in the current virtual env):

help: # @@Utils@@ Display help and exit
	python -m makefile_help

Comment each command with a description and optionally a section using @@
The makefile_help script will then generate a help string.

../makefile-help/image/demo.gif


Installation

pip install makefile-help

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

makefile-help-0.1.1.tar.gz (3.7 kB view details)

Uploaded Source

Built Distribution

makefile_help-0.1.1-py3-none-any.whl (4.3 kB view details)

Uploaded Python 3

File details

Details for the file makefile-help-0.1.1.tar.gz.

File metadata

  • Download URL: makefile-help-0.1.1.tar.gz
  • Upload date:
  • Size: 3.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.7.9 Darwin/19.6.0

File hashes

Hashes for makefile-help-0.1.1.tar.gz
Algorithm Hash digest
SHA256 f05dbbeb71f9dd178f2b75410818eef4e39070b55011a296967eb4fa644f47aa
MD5 18da6cfe30bc42005e53a84b8ba80ca9
BLAKE2b-256 5cb402d0a92a6ed3cd8271cecd6d0136b4fa52ad7a3e152ac00c0406c1d31a64

See more details on using hashes here.

File details

Details for the file makefile_help-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: makefile_help-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 4.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.7.9 Darwin/19.6.0

File hashes

Hashes for makefile_help-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b06ff7968a74b37c08a4db18892ad47c86fd8b1aec16313267af72154a32c4e0
MD5 7b75279d537ab4dd8e70d3683870792e
BLAKE2b-256 2eda259f3481545b498f33ed329e7b318f8da76551bdabe6186751dfb36b7fe0

See more details on using hashes here.

Supported by

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