panel-components's Introduction

panel-components

Panel is a powerful 💪 framework for creating awesome analytics apps in Python 🐍 using the tools you know 🧠 and love ❤️.

The purpose of the panel-components package is to enable users of Panel to create data applications with a modern look and feel by making it easy to integrate with

modern front end frameworks like Vue.js and React.
Component libraries like Bootstrap Vue, Material UI, Shoelace and Fast.
Any awesome .js library for data visualization and exploration.

The panel-components package does this by providing

A general framework for creating html components for Panel. See component.py.
- This includes html components based on Vue or React.
The basic HTML5 components. See tags.py.
A Vue.js component. See vue.py.

License

Licensed under the Apache License, Version 2.0

Getting Started

Installation

You can install via pip.

pip install panel-components.

Installing via

pip install -e git+https://github.com/paulopes/panel-components.git or
conda install

is currently not supported.

Examples

Hello World

Let's try a Hello World example.

File: hello_world.py

from panel_components.tags import h1

layout = h1("Hello World")

layout.servable()

panel-bootstrap-vue

The panel-bootstrap-vue package wraps the Bootstrap Vue component library and enables integration with Panel.

Contributing

Developer Instructions

In order to install this repo for development you should

Fork it
Git clone your Fork
Create a virtual environment in the root of the project folder

python -m venv .venv

Activate it via source .venv/Scripts/activate for git bash on windows and similar commands in other environments.
pip install panel.
Set your PYTHONPATH to the project root.

There are currently no tests with which you can verify everything is working.

Recommend Projects