Skip to main content

This package supports the Awesome Panel Project and provides highly experimental features!

Project description

Awesome Panel Package

This package supports the Awesome Panel Project and provides features that are not yet and maybe never will be provided by the Panel package.

This package is currently highly experimental and

  • The api might change dramatically and often!
    • If the Panel package starts providing the functionality, then it should be removed from this package.
  • If you find a version that works for you, then please pin the version number!
    • An example of pinning the version number is awesome-panel==20191208.2.

You can install it using

pip install awesome-panel

The express module contains improved widgets and extensions like fontawesome and bootstrap as well as the Bootstrap Dashboard Template used by awesome-panel.org. It should be imported as pnx.

import awesome_panel.express as pnx

For example the code below is used to configure the Bootstrap Dashboard App in the Gallery at awesome-panel.org.

Awesome Panel Org Animation

"""# BootstrapDashboard App.

Creates a Bootstrap Dashboard App

- inspired by the [GetBoostrap Dashboard Template]
(https://getbootstrap.com/docs/4.4/examples/dashboard/)
- implemented using the `awesome_panel' python package and in particular the
`awesome_panel.express.templates.BootstrapDashboardTemplate`
- Start the app by using `panel serve` on this file.
"""
import panel as pn

import awesome_panel.express as pnx
import gallery.bootstrap_dashboard.components as components

PAGES = [
    components.About(),
    components.dashboard_view(),
    components.plotly_view(),
    components.holoviews_view(),
    components.dataframe_view(),
    components.Limitations(),
]
MENU_BUTTON_CSS_CLASSES = [
    ["navigation", "pas", "pa-home"],
    ["navigation", "pas", "pa-chart-line"],
    ["navigation", "pas", "pa-chart-bar"],
    ["navigation", "pas", "pa-chart-pie"],
    ["navigation", "pas", "pa-table"],
    ["navigation", "pas", "pa-bug"],
]


def main() -> pn.Pane:
    """## Bootstrap Dashboard App

    Creates a Bootstrap Dashboard App

    - inspired by the [GetBoostrap Dashboard Template]
    (https://getbootstrap.com/docs/4.4/examples/dashboard/)
    - implemented using the `awesome_panel' python package and in particular the
    `awesome_panel.express.templates.BootstrapDashboardTemplate`

    Returns:
        pn.Pane -- The Bootstrap Dashboard App
    """
    pnx.fontawesome.extend()

    app = pnx.templates.BootstrapDashboardTemplate(app_title="Bootstrap Dashboard")
    navigation_menu = pnx.NavigationMenu(
        pages=PAGES, page_outlet=app.main, css_classes=MENU_BUTTON_CSS_CLASSES
    )
    app.sidebar.append(navigation_menu)
    return app


if __name__.startswith("bk_script"):
    main().servable()

For more information please visit the Awesome Panel Project on GitHub.

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

awesome-panel-20200408.1.tar.gz (23.1 kB view details)

Uploaded Source

File details

Details for the file awesome-panel-20200408.1.tar.gz.

File metadata

  • Download URL: awesome-panel-20200408.1.tar.gz
  • Upload date:
  • Size: 23.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.4

File hashes

Hashes for awesome-panel-20200408.1.tar.gz
Algorithm Hash digest
SHA256 c2b5ee6079060ca4c3859a83a645032e33b2926882006eca481ebe29e0b835bc
MD5 d24de3ee2b7239025d5c57bdb539c1c4
BLAKE2b-256 17253abc37b760ffc2b7ed50eefa7b7e640fcad2f87c0b8b64f39693afd52639

See more details on using hashes here.

Supported by

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