holoviz/panel

Document hvplot .interactive with Panel

Open

#2,871 opened on Nov 2, 2021

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Python (615 forks)auto 404
good first issuetype: docstype: enhancement

Repository metrics

Stars
 (5,722 stars)
PR merge metrics
 (PR metrics pending)

Description

I believe the combination of hvplot .interactive and Panel is really, really powerful. It's probably the simples, most intuitive and most powerful of all the apis that Panel support.

The only weakness I see is that it has to start with an instance of a DataFrame.

I believe this power should be documented in Panel.

Discussion

I see the following options

  1. Add it to the APIs user guide.
  2. Create a seperate user guide. For example
    • DataFrame Pipeline
    • DataFrame Data Apps
  3. Add one or more options to the gallery
  4. Include a copy-pastable example on the home page of panel.

Examples

Gallery .py example

One example is here https://gist.github.com/MarcSkovMadsen/ffb273636dced88705c8c88d5ee28f23.

https://user-images.githubusercontent.com/42288570/139596203-c5021ffd-d964-4a73-bbac-c31f9049130e.mp4

Feel free to copy or request a PR.

Gallery .ipynb example

One example is here https://gist.github.com/MarcSkovMadsen/e666503df2aa1d8d047dcb9555b5da6d

https://user-images.githubusercontent.com/42288570/139733940-9a46ced0-6651-4054-830d-8804a441c47f.mp4

Feel free to copy or request a PR.

Contributor guide

Research direction
Review Panel's existing user guides and gallery, identify where to add hvplot .interactive documentation, and adapt the provided examples into a new section.
Tech stack
python
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonPanel basicshvplot basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65