Skip to main content

Provides functions to check your package's users's python version and shows message to your users continues or stops or accepts callbacks depending your choice.

Project description

Python package PyPI Supported Python Versions Downloads

comply

from comply import check_comply

checks if user's python version is compatible with your project

def check_comply(
        min_version: str,
        max_version: str,
        min_msg: t.Union[str, t.Callable] = default_min_msg,
        max_msg: t.Union[str, t.Callable] = default_max_msg,
        complyible_msg: t.Union[str, t.Callable] = default_comply_msg,
        verbose: bool = True,
        mock_sys_version: t.Union[str, bool] = False, # for test purposes

):

Use case 1 : main file on your project to continue or stop running

you may use it on the main file of your project and create a conditional and decide what to do next

if check_compat(
        min_version="3.7",
        max_version="3.11",
        min_msg="Your version is less than minimum.",
        verbose=True,

    ) is False : 
        sys.exit(0) # return # or just exit
# if user's python has a version of lets say 3.4 this will print your customized message and exit.

just warn the user and continue

if check_compat(
        min_version="3.7",
        max_version="3.10",
        min_msg="Your version is less than minimum.",
        max_msg="Your version is greater than the minimum.",
        verbose=True,

    ) is False : 
        pass   
# if user's machine has a python with version of 
# lets say 3.4 this will print your customized message and continue .

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

comply-0.0.0.3-py2.py3-none-any.whl (4.8 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page