DEVELOPER_GUIDE.md

❤️ Developer Guide

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

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

🧳 Prerequisites

• A working Python environment.
• Git CLI.

📙 How to

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

💻 Install for Development

To install for development you will need to create a new environment

Then run

git clone https://github.com/awesome-panel/awesome-panel.git
cd awesome-panel
pip install pip -U
pip install -e .[dev,examples]

Then you can see the available commands via

pn --help

You can run all tests via

pn test all

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

Serve the site

mkdir -p apps/dev/www
mkdir -p apps/prod/www
panel serve examples/*.py examples/*.ipynb --glob --num-procs 4 --num-threads 0 --index home.py --static-dirs apps-dev=apps/dev/www apps=apps/prod/www

🚢 Release a new package on Pypi

Update the version in the init.py.

Then run

pn test all

Then you can build

pn build package

and upload

pn release package <VERSION>

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