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.39.tar.gz (758.7 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: vois-1.0.39.tar.gz
  • Upload date:
  • Size: 758.7 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.39.tar.gz
Algorithm Hash digest
SHA256 a8cc70f8a89d7379005778d64f44c401618569438ead0bd51e2de61936cdd48a
MD5 300ce06c8a60cf5c67bd6b126952700a
BLAKE2b-256 76a5982099b91ec896a9795f9454c40909abdac4fb4e0d03daf4d7d5acc76bc4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: vois-1.0.39-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.39-py3-none-any.whl
Algorithm Hash digest
SHA256 6b597fb7443ce4a3e5e9633d842cad1c1aa47d80c66524c663d4bbc9c26e9794
MD5 4d8c81cccf762ba39464e0d23a835afe
BLAKE2b-256 a6cbad901c87ded71e302d309e102c0059ce36294b5fd1d0ab49f2e8768cce6c

See more details on using hashes here.

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