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

Metadata

Release files for userinput 1.0.22

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for userinput 1.0.22
File	Size	Uploaded	Provenance	Actions
userinput-1.0.22.tar.gz	10.4 kB	Dec 7, 2023	Without provenance	Details for userinput-1.0.22.tar.gz

Release files / userinput-1.0.22.tar.gz

Download URL	userinput-1.0.22.tar.gz
Size	10.4 kB
Tags	Source
SHA-256 checksum How to use checksums	`b74ef2221c3749ecfd845763caa4d4f7d5554e4ab5c5828f775f10566b401690`
BLAKE2b-256 checksum How to use checksums	`bb4f113bb1d8584a73614ab119fa9c638cee9929ed13538f86186471330a7c05`
Upload date	Dec 7, 2023
Uploaded using Trusted Publishing? What is 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`

Security for userinput 1.0.22

Report project as malware

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

userinput 1.0.22