userinput

Simple python package to handle CLI user input.

How do I install this package?

As usual, just download it using pip:

pip install userinput

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
    ]
)

Download files

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

Source Distribution

userinput-1.0.22.tar.gz (10.4 kB view details)

Uploaded Dec 7, 2023 Source

File details

Details for the file userinput-1.0.22.tar.gz.

File metadata

Download URL: userinput-1.0.22.tar.gz
Upload date: Dec 7, 2023
Size: 10.4 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.63.1 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.7.9

File hashes

Hashes for userinput-1.0.22.tar.gz
Algorithm	Hash digest
SHA256	`b74ef2221c3749ecfd845763caa4d4f7d5554e4ab5c5828f775f10566b401690`
MD5	`0ffcd8d18c7866793adab5521cd8c39d`
BLAKE2b-256	`bb4f113bb1d8584a73614ab119fa9c638cee9929ed13538f86186471330a7c05`