Skip to main content

Simple python package to handle cli user input.

Project description

Travis CI build SonarCloud Quality SonarCloud Maintainability Codacy Maintainability Maintainability Pypi project Pypi total project downloads

Simple python package to handle CLI user input.

How do I install this package?

As usual, just download it using pip:

pip install userinput

Tests Coverage

Since some software handling coverages sometimes get slightly different results, here’s three of them:

Coveralls Coverage SonarCloud Coverage Code Climate Coverate

Available validators

Some commonly used validators are available with the package.

Validator name Description
email Check if given input string is a valid email.
version_code Check if given input string is a valid version code.
url Check if given input string is a valid URL. Does not check if given URL is online.
human_bool Check if given input string is a human Boolean, such as “yes”, “y”, “true”, “si”, “no”, “n”, “false”.
integer Check if given input string is a integer numeric value.
positive_integer Check if given input string is a positive integer numeric value.
non_empty Check if given input string is not empty.
hostname Check if given input string is a reachable host name.
ip Check if given input string is a reachable IP address.

Use them as follows:

from userinput import userinput

result = userinput(
    "my_label",
    validator="validator name goes here"
)

You can also chain validators. They will be called in the order you provide.

from userinput import userinput

result = userinput(
    "my_label",
    validator=[
        "validator name goes here",
        my_custom_validation_function
    ]
)

Available sanitizers

Some commonly used sanitizers are available with the package.

Validator name Description
human_bool Cast human Boolean specified above in validators to python Booleans.
strip Remove padding spaces and repeated spaces.

Use them as follows:

from userinput import userinput

result = userinput(
    "my_label",
    sanitizer="sanitizer name goes here"
)

You can also chain sanitizers. They will be called in the order you provide.

from userinput import userinput

result = userinput(
    "my_label",
    sanitizer=[
        "sanitizer name goes here",
        my_custom_sanitification_function
    ]
)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for userinput, version 1.0.14
Filename, size File type Python version Upload date Hashes
Filename, size userinput-1.0.14.tar.gz (8.1 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page