prmt


Nameprmt JSON
Version 4.1.0 PyPI version JSON
download
home_pagehttps://github.com/feluxe/prmt
SummarySimple and robust command line prompts for most values
upload_time2023-11-25 05:31:39
maintainerfeluxe
docs_urlNone
authorfeluxe
requires_python>=3.7,<4.0
licenseApache-2.0
keywords command line prompt user input
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # prmt


### Description

Simple and robust command line prompts for most of the values.
The formatting of the questions and prompts is completely customizable.
This lib has no dependencies and no magic.

**Features:**

* Prompt bool from user. (`prmt.confirm`)
* Prompt string from user. (`prmt.string`)
* Prompt string from user, opening an editor window. (`prmt.string_from_editor`)
* Prompt integer from user. (`prmt.integer`)
* Prompt list of strings from user. (`prmt.list_of_str`) 
* Prompt user to select an item from a list/dict of items. (`prmt.select`)

**Optional features:**

* Set default values.
* Customize formatting for each prompt. 
* Customize formatting for all prompts via the `prmt.Prompt()` class.
* Open default Text Editor for the user to enter text.
* Blacklist values. (If the user enters blacklisted values she will be prompted again)


### Requirements

Python `>=3.7`


### Install

    pip install prmt

or

    poetry install prmt


### Examples

Look into the `tests` folder for code examples.

To see it in action on the command line, run:

    pipenv run python make.py test



### Development

    git clone https://github.com/feluxe/prmt.git

    cd prmt

    pipenv install --dev --pre

    pipenv run python make.py --help



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/feluxe/prmt",
    "name": "prmt",
    "maintainer": "feluxe",
    "docs_url": null,
    "requires_python": ">=3.7,<4.0",
    "maintainer_email": "felix@meyerwolters.de",
    "keywords": "command,line,prompt,user,input",
    "author": "feluxe",
    "author_email": "felix@meyerwolters.de",
    "download_url": "",
    "platform": null,
    "description": "# prmt\n\n\n### Description\n\nSimple and robust command line prompts for most of the values.\nThe formatting of the questions and prompts is completely customizable.\nThis lib has no dependencies and no magic.\n\n**Features:**\n\n* Prompt bool from user. (`prmt.confirm`)\n* Prompt string from user. (`prmt.string`)\n* Prompt string from user, opening an editor window. (`prmt.string_from_editor`)\n* Prompt integer from user. (`prmt.integer`)\n* Prompt list of strings from user. (`prmt.list_of_str`) \n* Prompt user to select an item from a list/dict of items. (`prmt.select`)\n\n**Optional features:**\n\n* Set default values.\n* Customize formatting for each prompt. \n* Customize formatting for all prompts via the `prmt.Prompt()` class.\n* Open default Text Editor for the user to enter text.\n* Blacklist values. (If the user enters blacklisted values she will be prompted again)\n\n\n### Requirements\n\nPython `>=3.7`\n\n\n### Install\n\n    pip install prmt\n\nor\n\n    poetry install prmt\n\n\n### Examples\n\nLook into the `tests` folder for code examples.\n\nTo see it in action on the command line, run:\n\n    pipenv run python make.py test\n\n\n\n### Development\n\n    git clone https://github.com/feluxe/prmt.git\n\n    cd prmt\n\n    pipenv install --dev --pre\n\n    pipenv run python make.py --help\n\n\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "Simple and robust command line prompts for most values",
    "version": "4.1.0",
    "project_urls": {
        "Homepage": "https://github.com/feluxe/prmt",
        "Repository": "https://github.com/feluxe/prmt"
    },
    "split_keywords": [
        "command",
        "line",
        "prompt",
        "user",
        "input"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b8c631ed90a7039ab97ac82d05234bc81bcf6509cf398266e47f5732744ca0c3",
                "md5": "766a2a0d211223ef5c03e144b0d498b4",
                "sha256": "94b254a5ae59d07873e296166134a9a7491a1040ad4ce0e96cf73c16077e83b9"
            },
            "downloads": -1,
            "filename": "prmt-4.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "766a2a0d211223ef5c03e144b0d498b4",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7,<4.0",
            "size": 9733,
            "upload_time": "2023-11-25T05:31:39",
            "upload_time_iso_8601": "2023-11-25T05:31:39.980655Z",
            "url": "https://files.pythonhosted.org/packages/b8/c6/31ed90a7039ab97ac82d05234bc81bcf6509cf398266e47f5732744ca0c3/prmt-4.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-11-25 05:31:39",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "feluxe",
    "github_project": "prmt",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "prmt"
}
        
Elapsed time: 0.13992s