Metadata-Version: 2.1
Name: prmt
Version: 3.0.1
Summary: Prompt user for commandline input.
Home-page: https://github.com/feluxe/prmt
Author: Felix Meyer-Wolters
Author-email: felix@meyerwolters.de
Maintainer: Felix Meyer-Wolters
Maintainer-email: felix@meyerwolters.de
License: unlicensed
Download-URL: https://github.com/feluxe/prmt/tarball/3.0.1
Keywords: prompt,commandline,input
Platform: 
Description-Content-Type: text/markdown


# prmt


### Description

Prompt user for values on the command line.

**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. 
* 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.6`


### Install

    pip install prmt

or

    pipenv 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



