DEVELOPER_GUIDE.md

❤️ Developer Guide

Welcome. We are so happy that you want to contribute.

🧳 Prerequisites

• A working Python environment.
• Git CLI.

📙 How to

Below we describe how to install and use this project for development.

Git Clone

git clone https://github.com/marcskovmadsen/awesome-panel-extensions
cd awesome-panel-extensions

Create an environment with pip

Please note getting node.js might be easier with conda. See below for instructions.

You can create and activate a virtual environment with pip by running.

python -m venv .venv
source .venv/bin/activate # works on linux. Other command is nescessary for windows.

You will also need to install nodejs and make it available on your PATH.

Create an environment with conda

You can create and activate a virtual environment with conda by running.

conda create --name awesome-panel-extensions python=3.9 nodejs
conda activate awesome-panel-extensions

Install for development

Install the awesome-panel-extensions package for editing

pip install pip -U
pip install -e .[dev,examples]

This will also install the awesome-panel-cli tool.

You can see the available commands via

pn --help

You can run all tests via

pn test all

Please always run this command and fix any failing tests if possible before you git push.

Update Bokeh JS

Make sure Bokeh is up to date

cd src/awesome_panel_extensions
npm update @bokeh/bokehjs --save
npm audit fix
cd ../..

Build the Package

Update the version number in the init.py and package.json files.

Then build the Bokeh models

panel build src/awesome_panel_extensions

Finally you can build the package

pn build package

🚢 Release a new package on Pypi

Start by running all tests successfully

pn test all

The Build the package and run

pn release package <VERSION>

to release the package 📦. To upload to Test Pypi first, you can add the --test flag.