makefile-help

Name	makefile-help JSON
Version	0.1.1 JSON
	download
home_page	https://github.com/simonwardjones/makefile-help
Summary	Autogenerates pretty Makefile help
upload_time	2021-01-11 19:43:32
maintainer
docs_url	None
author	simonwardjones
requires_python	>=3.7,<4.0
license	MIT
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # Makefile help

![](https://img.shields.io/pypi/v/makefile-help)

This small package helps by generating colourful help for Makefiles.
- [Makefile help](#makefile-help)
    - [Why?](#why)
    - [Usage](#usage)
    - [Installation](#installation)

---
### 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](https://raw.githubusercontent.com/simonwardjones/makefile-help/main/image/demo.gif)

---
### Installation

`pip install makefile-help`
            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/simonwardjones/makefile-help",
    "name": "makefile-help",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7,<4.0",
    "maintainer_email": "",
    "keywords": "",
    "author": "simonwardjones",
    "author_email": "simonwardjones@yahoo.co.uk",
    "download_url": "https://files.pythonhosted.org/packages/5c/b4/02d0a92a6ed3cd8271cecd6d0136b4fa52ad7a3e152ac00c0406c1d31a64/makefile-help-0.1.1.tar.gz",
    "platform": "",
    "description": "# Makefile help\n\n![](https://img.shields.io/pypi/v/makefile-help)\n\nThis small package helps by generating colourful help for Makefiles.\n- [Makefile help](#makefile-help)\n    - [Why?](#why)\n    - [Usage](#usage)\n    - [Installation](#installation)\n\n---\n### Why?\n\nI often store useful commands in Makefiles and then promptly forget them.\n\n---\n### Usage\n\nAt the top of a Makefile add the following (assuming makefile-help is installed in the current virtual env):\n\n```\nhelp: # @@Utils@@ Display help and exit\n\tpython -m makefile_help\n```\n\nComment each command with a description and optionally a section using `@@`  \nThe makefile_help script will then generate a help string.\n\n![../makefile-help/image/demo.gif](https://raw.githubusercontent.com/simonwardjones/makefile-help/main/image/demo.gif)\n\n---\n### Installation\n\n`pip install makefile-help`",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Autogenerates pretty Makefile help",
    "version": "0.1.1",
    "project_urls": {
        "Homepage": "https://github.com/simonwardjones/makefile-help"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2eda259f3481545b498f33ed329e7b318f8da76551bdabe6186751dfb36b7fe0",
                "md5": "7b75279d537ab4dd8e70d3683870792e",
                "sha256": "b06ff7968a74b37c08a4db18892ad47c86fd8b1aec16313267af72154a32c4e0"
            },
            "downloads": -1,
            "filename": "makefile_help-0.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7b75279d537ab4dd8e70d3683870792e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7,<4.0",
            "size": 4254,
            "upload_time": "2021-01-11T19:43:33",
            "upload_time_iso_8601": "2021-01-11T19:43:33.367494Z",
            "url": "https://files.pythonhosted.org/packages/2e/da/259f3481545b498f33ed329e7b318f8da76551bdabe6186751dfb36b7fe0/makefile_help-0.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5cb402d0a92a6ed3cd8271cecd6d0136b4fa52ad7a3e152ac00c0406c1d31a64",
                "md5": "18da6cfe30bc42005e53a84b8ba80ca9",
                "sha256": "f05dbbeb71f9dd178f2b75410818eef4e39070b55011a296967eb4fa644f47aa"
            },
            "downloads": -1,
            "filename": "makefile-help-0.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "18da6cfe30bc42005e53a84b8ba80ca9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7,<4.0",
            "size": 3716,
            "upload_time": "2021-01-11T19:43:32",
            "upload_time_iso_8601": "2021-01-11T19:43:32.078701Z",
            "url": "https://files.pythonhosted.org/packages/5c/b4/02d0a92a6ed3cd8271cecd6d0136b4fa52ad7a3e152ac00c0406c1d31a64/makefile-help-0.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2021-01-11 19:43:32",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "simonwardjones",
    "github_project": "makefile-help",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "makefile-help"
}