Skip to main content

A Python Voilà simplification library

Project description

logo

Python library to simplify the creation of impactful Voilà dashboards.

The online documentation for the vois library is available here

The PDF documentation for the vois library is available here

The source repository is available here

The vois library contains:

package vois: helper functions for tasks not directly related to ipyvuetify (manage geojson files, create an interactive map to display custom geojson, simplify visualization of hierarchical data in Plotly, create custom SVG visualizations, etc.)

package vois/vuetify: classes to simplify the development of GUIs using ipyvuetify (each source file contains a wrapper to simplify the usage of a ipyvuetify widget)

License

VOIS library is released under a EUPL Version 1.2 license.

Setup

The vois library can be installed using this command:

pip install vois

News

In order to help new users of the vois library to start using the library without the need to read all the documentation, we have created two dashboards that help in visually define a multipage application structure.

These tools are deployed as Voilà dashboards in Microsoft Azure Cloud at this URL: https://vois.azurewebsites.net/

vois_helpers_1

The "Main Page Configurator" is a visual tool to create the starting page of a multipage application, by visually position titles, logos, buttons, credits on top of a background image. Sixty predefined background images are available but also custom background images can be uploaded. The result of the visual configuration can be saved locally as a json file and a notebook .ipynb file and immediately used as the first building block of your application.

vois_helpers_2

The "Page Configurator" enables the visual configuration of one of your application pages. Users can define the colors, the logos, the content of the page (one or more maps, charts, drawings, etc.) and the number of panels that will contain the widgets that control the application behaviour. Once done, the page configuration can be downloaded locally as a json file, a pyton file and a notebook, and immediately used in JupyterLab.

vois_helpers_3

Example of a page with a left panel and a bottom panel. The content of the page consists of two maps and a chart.

Tutorial

The tutorial section of the documentation available here provides a step by step example for the construction of a dashboard to display EUROSTAT data on Energy Consumption in Europe.

screenshot

These are the links to all the steps of the example dashboard deployed and published by Hugginface Spaces:

Step.1: Creation of the dashboard structure using the app class

Step.2: Use Pandas to read the input CSVs and display the DataFrame as a table

Step.3: Add the filtering controls to the dashboard to select countries and sector

Step.4: Add the Plotly Bar Chart View

Step.5: Add the SVG Static Map View

Step.6: Add the Dynamic Map View

Step.7: Add the functions for downloading chart, table and map

Step.8: Manage the parameters passsed in the URL and open external URLs

Step.9: Add an interactive AnimatedPieChart in SVG to select the consumption sector

Step.Final: Add minipanel to footer bar and the function to generate and download a report in docx format

Step.Final.Dark: Dark version of the final dashboard

An example multi-page dashboard can be viewed at this link: Example multi-page dashboard

screenshot

Project details


Download files

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

Source Distribution

vois-1.0.38.tar.gz (758.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vois-1.0.38-py3-none-any.whl (846.4 kB view details)

Uploaded Python 3

File details

Details for the file vois-1.0.38.tar.gz.

File metadata

  • Download URL: vois-1.0.38.tar.gz
  • Upload date:
  • Size: 758.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.9

File hashes

Hashes for vois-1.0.38.tar.gz
Algorithm Hash digest
SHA256 ae9f247080b709bc4fdcc3ce901a78c2e5ee82141c00db095ca43eae9dd40b6a
MD5 30cfe0a406f76437debb23f0d5d39b14
BLAKE2b-256 4d98cc2140c3521ae46404d7abd21c20ddcaa81102c53b7bd17dcc2f638cd765

See more details on using hashes here.

File details

Details for the file vois-1.0.38-py3-none-any.whl.

File metadata

  • Download URL: vois-1.0.38-py3-none-any.whl
  • Upload date:
  • Size: 846.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.9

File hashes

Hashes for vois-1.0.38-py3-none-any.whl
Algorithm Hash digest
SHA256 8349f6a5d5762d01bad6b8bc829077298633e1ec7986ce8571695be5f45b50b3
MD5 975dce90b15e8daac697fc44ce75104f
BLAKE2b-256 41f771666656355ec06c26502797debe9da1c1ff9e890d065dab9d2a15047359

See more details on using hashes here.

Supported by

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