search

v.0.14

2023.01.13

triangle-exclamation

This version has been deprecated. If used with the current API version it can produce unexpected behaviour or errors.

triangle-exclamation

The package shimoku-api-python is no longer maintained

circle-info

To get the new version 🚀

pip install --upgrade shimoku-api-python

This version comes with a lot of new features and quality of life improvements! This will be a trend for a couple of the next versions.

hashtag
Fixes

  • Tabs have been fixed and improved! Now when they are deleted they will delete all their contents and will not leave child plots around like they did until now. Also tables work within tabs and a feature to order the tabs order inside of the tabs group has been added.

    By default the tabs will respect the order of creation but the function s.plt.change_tabs_group_internal_order() can be used to give them an arbitrary order.

    This example:

    menu_path: str = 'test/tabs-test'

data = [
    {'date': dt.date(2021, 1, 1), 'x': 5, 'y': 5},
    {'date': dt.date(2021, 1, 2), 'x': 6, 'y': 5},
    {'date': dt.date(2021, 1, 3), 'x': 4, 'y': 5},
    {'date': dt.date(2021, 1, 4), 'x': 7, 'y': 5},
    {'date': dt.date(2021, 1, 5), 'x': 3, 'y': 5},
]

s.plt.bar(
    data=data,
    x='date', y=['x', 'y'],
    menu_path=menu_path,
    x_axis_name='Date',
    y_axis_name=['Revenue'],
    # row=1, column=1,
    order=0, rows_size=2,
    cols_size=12,
    tabs_index=("Tabs group", "Bar")
)

report_dataset_properties = {
    'fields': [
        {
            'title': 'Personal information',
            'fields': [
                {
                    'mapping': 'name',
                    'fieldName': 'name',
                    'inputType': 'text',
                },
                {
                    'mapping': 'surname',
                    'fieldName': 'surname',
                    'inputType': 'text',
                },
                {
                    'mapping': 'age',
                    'fieldName': 'age',
                    'inputType': 'number',
                },
                {
                    'mapping': 'tel',
                    'fieldName': 'phone',
                    'inputType': 'tel',
                },
                {
                    'mapping': 'gender',
                    'fieldName': 'Gender',
                    'inputType': 'radio',
                    'options': ['Male', 'Female', 'No-binary', 'Undefined'],
                },
                {
                    'mapping': 'email',
                    'fieldName': 'email',
                    'inputType': 'email',
                },

            ],
        },
        {
            'title': 'Other data',
            'fields': [
                {
                    'mapping': 'skills',
                    'fieldName': 'Skills',
                    'options': ['Backend', 'Frontend', 'UX/UI', 'Api Builder', 'DevOps'],
                    'inputType': 'checkbox',
                },
                {
                    'mapping': 'birthDay',
                    'fieldName': 'Birthday',
                    'inputType': 'date',
                },
                {
                    'mapping': 'onCompany',
                    'fieldName': 'Time on Shimoku',
                    'inputType': 'dateRange',
                },
                {
                    'mapping': 'hobbies',
                    'fieldName': 'Hobbies',
                    'inputType': 'select',
                    'options': ['Make Strong Api', 'Sailing to Canarias', 'Send Abracitos'],
                },
                {
                    'mapping': 'textField2',
                    'fieldName': 'Test Text',
                    'inputType': 'text',
                },
                {
                    'mapping': 'objectives',
                    'fieldName': 'Objetivos',
                    'inputType': 'multiSelect',
                    'options': ['sleep', 'close eyes', 'awake']
                },

            ],
        },
    ],
}

s.plt.input_form(
    menu_path=menu_path, order=0,
    report_dataset_properties=report_dataset_properties,
    tabs_index=("Tabs group", "Input Form")
)
data_table = [
    {'date': dt.date(2021, 1, 1), 'x': 5, 'y': 5, 'filtA': 'A', 'filtB': 'Z', 'name': 'Ana'},
    {'date': dt.date(2021, 1, 2), 'x': 6, 'y': 5, 'filtA': 'B', 'filtB': 'Z', 'name': 'Laura'},
    {'date': dt.date(2021, 1, 3), 'x': 4, 'y': 5, 'filtA': 'A', 'filtB': 'W', 'name': 'Audrey'},
    {'date': dt.date(2021, 1, 4), 'x': 7, 'y': 5, 'filtA': 'B', 'filtB': 'W', 'name': 'Jose'},
    {'date': dt.date(2021, 1, 5), 'x': 3, 'y': 5, 'filtA': 'A', 'filtB': 'Z', 'name': 'Jorge'},
]
filter_columns: List[str] = ['filtA', 'filtB']
search_columns: List[str] = ['name']

s.plt.table(
    title="Test-table",
    data=data_table,
    menu_path=menu_path,
    order=0,
    filter_columns=filter_columns,
    sort_table_by_col={'date': 'asc'},
    search_columns=search_columns,
    tabs_index=('Tabs group', 'Table')
)

s.plt.change_tabs_group_internal_order(
    group_name='Tabs group', menu_path=menu_path,
    tabs_list=['Table', 'Bar', 'Input Form']
)

    Resutls in:

    Arbitrary tabs order and table within tabs

hashtag
Improvements

  • To increase the robustness of the Shimoku platform in situations of high loads, such as uploading large tables, we have implemented a technique called exponential backoff. This technique automatically retries failed operations or requests, increasing the chances of success. This feature is always on and does not require any configuration or enabling by the users.

  • The deletion of apps has been improved significantly efficiency-wise, now both s.plt.clear_business() and s.plt.delete_path() (Only when the app name is provided without a sub-path) are far faster and convenient to use.

  • Now there is an option to change the theme of the business to adatpt it more to the case needs. The function s.business.update_business_theme() needs to be provided with a dictionary for all the options that want to be changed, this features options will be explained in detail in it's respective entry.

    An example on how to use it is:

    with the result being:

    Modified theme shimoku

  • The following charts got an update on the style of the toolbox: stacked barchart, horizontal stacked barchart and stacked area chart.

    The new toolbox look is:

    New Toolbox

  • Indicators now use an updated version that lets them have a lot of new features, but now when a group of indicators is passed as the input data each one of them uses one position in the grid, so they use n orders. To make this easier to work with, the function s.plt.indicator returns the next available order value

    An example on how to use it would be:

    the result is:

    Resulting indicators with dynamic order

  • The option to arrange indicators vertically has been added, through the use of the parameter vertical. This allows the user to create a column of indicators, using a bentobox with the provided cols_size (that by default is 12), and including the indicators inside. This option has no limit of indicators and will continue to grow vertically. To use this feature, pass True to the vertical parameter when calling the indicator function. Additionally, a title can be added to the top of the bentobox by passing a string to the same parameter vertical (If its set to True it will arrange them vertically but will not set any title).

    An example would be:

    resulting in:

    Vertical arrangement of indicators

  • A new composite plot has been added! The gauge indicator uses an indicator and a gauge chart and joins them with a bentobox.

    When we execute this example:

    The result is:

    Gauge indicators

  • A new input form component has been added, the audio-recorder. It is used to record snippets of audio and send them.

    An example on how to use it is:

    results in:

    Audio recorder component

    To begin recording, the user just has to press the button with the microphone symbol:

    And press it again to stop recording:

    Multiple audios can be recorded:

  • The html components of the library shimoku-components-catalog have been added as an intern module of the SDK in the form of s.html_components. They are used in the same way as before, when called they provide the necessary html code to call s.plt.html().

    So now we can use the html components without needing to import the additional library:

    Html component created without manually importing the library
Previousv.0.15Next2022

Last updated

Was this helpful?