Metadata-Version: 2.1
Name: vvapp
Version: 0.0.6
Summary: A python library simplifying development of ipyvuetify voila apps
Home-page: https://github.com/radinplaid/vvapp/tree/master/
Author: Mark Franey
Author-email: franey.mark@gmail.com
License: Apache Software License 2.0
Description: # vvapp
        > A python library simplifying ipyvuetify voila application building.
        
        
        ## Documentation
        
        https://radinplaid.github.io/vvapp/
        
        ## Install
        
        `pip install vvapp`
        
        ## Inputs
        
        `vvapp` is meant to be used in Jupyter, so launching jupyter first (`$jupyter notebook`).
        
        There are a few key things to keep in mind when getting up and running with `vvapp`:
        
        * `v_model`
            * The value of `vvapp` inputs is set and accessed via the `v_model` attribute, following the `ipyvuetify` convention
        * `class_`
            * This is where you put `vuetify.js` class properties, like `ma-4` to add margins around the input
        * `style_`
            * This is where you can add CSS to your elements
        * `hint`
            * The `hint` can be a string *or* a callable to provide input validation
            * If `hint` is a callable, it must return a string or None; if it returns a string, the input is marked as invalid and the string is displayed
                
        
        ```
        from vvapp.inputs import __all__ as available_input_widgets
        available_input_widgets
        ```
        
        
        
        
            ['password', 'time', 'date', 'number']
        
        
        
        ### radio_buttons
        
        ```
        from vvapp.inputs import radio_buttons
        radio_buttons(choices={
                            'Apple': 'apple',
                            'Blueberry': 'blueberry',
                            'Pumpkin': 'pumpkin'
                        },
                      label='What is your favourite pie flavour?',
                      v_model='blueberry')
        ```
        
        <img alt="Radio Button Input" caption="Radio Button" src="images/radio_buttons.png">
        
        ### date
        
        ```
        from vvapp.inputs import date
        date(label='Please enter a date (format: YYYY-mm-dd)',
             v_model='2020-04-15',
             style_='max-width:320px')
        ```
        
        <img alt="Date Input" caption="Date Input" src="images/input_date.png">
        
        ### time
        
        ```
        from vvapp.inputs import time
        time(label='Please enter a time (format: HH:MM)',
             v_model='13:34',
             style_='max-width:320px')
        ```
        
        
        <img alt="Time Input" caption="Time Input" src="images/input_time.png">
        
        
        ### number
        
        ```
        from vvapp.inputs import number
        number(placeholder='Enter a number',
             style_='max-width:320px')
        ```
        
        <img alt="Number Input" caption="Number Input" src="images/input_number.png">
        
        
        `number` inputs have a default validation function that changes the `error` state of the input to True and prints a sensible hint if the value is less than `min_value` or greater than `max_value`
        
        ```
        from vvapp.inputs import number
        number(label='Number Input',
               v_model=123,
               min_value=0,
               max_value=100,
             style_='max-width:320px')
        ```
        
        
        <img alt="Number Input With Validation" caption="Number Input With Validation" src="images/input_number_validation.png">
        
        
        ### password
        
        ```
        from vvapp.inputs import password
        pw = password(label='Please enter a password',v_model='correcthorsebatterystapler')
        pw
        ```
        
        <img alt="Password Input" caption="Password Input" src="images/input_password.png">
        
        
        The value of of a vvapp widget is set/accessed by the `v_model` attribute, just like in ipyvuetify
        
        ```
        pw.v_model
        ```
        
        
        
        
            'correcthorsebatterystapler'
        
        
        
        Here we demonstrate the use of a function to validate the value of the input.
        
        In this example the password must be at least 12 characters, less than 64 characters and include at least one number:
        
        ```
        import re
        def validate_pw(widget_value):
            if widget_value is None:
                return 'Input must not be None'
        
            else:
                if len(widget_value) < 12:
                    return 'Too Short!'
        
                if len(widget_value) > 64:
                    return 'Too Long!'
        
                if not re.search('[0-9]+',widget_value):
                    return 'Must contain at least one number!'
        
            return None
        
        pw = password(label='Please enter a password',v_model='correcthorsebatterystapler', hint=validate_pw)
        pw
        ```
        
        <img alt="Password Input with Validation" caption="Password Input with Validation" src="images/input_password_validation.png">
        
        
        ## Outputs
        
        ### PandasTable
        
        ```
        import pandas as pd
        from vvapp.outputs import PandasTable
        df = pd.DataFrame({'a':[1,2,3],'b':[2,3,4]})
        PandasTable(data=df,title='My DataFrame')
        ```
        
        <img alt="Pandas Dataframe Output" caption="Pandas Dataframe Output" src="images/output_pandas_table2.png">
        
        
        The pandas DataFrame output has a nice warning/error display if the search returns zero results or if are no rows in the PandasDataframe:
        
        ```
        import pandas as pd
        from vvapp.outputs import PandasTable
        df = pd.DataFrame({'a':[1,2,3],'b':[2,3,4]})
        PandasTable(data=df,title='My DataFrame')
        ```
        
        <img alt="Pandas Dataframe Output No Search Results" caption="Pandas Dataframe Output No Search Results" src="images/output_pandas_table_zeroresults.png">
        
        
        ```
        import pandas as pd
        from vvapp.outputs import PandasTable
        PandasTable(data=pd.DataFrame(),title='My DataFrame')
        ```
        
        <img alt="Pandas Dataframe Output No Data" caption="Pandas Dataframe Output No Data" src="images/output_pandas_table_nodata.png">
        
        
Keywords: python,jupyter,voila
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.6
Description-Content-Type: text/markdown
