DEVELOPER_GUIDE.md

❤️ Developer Guide

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

🧳 Prerequisites

• A conda environment.
• Git CLI.

You can also use pip if you can get node.js installed.

📙 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 and activate a virtual environment

conda create --name panel-chemistry python=3.9 nodejs
conda activate panel-chemistry

Then run

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

This will install the awesome-panel-cli. 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.

Build the Bokeh models

panel build src/panel_chemistry

🚢 Release a new package on Pypi

Please make sure you have upgraded bokeh

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

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

Then run

pn test all

Then you can build

panel build src/panel_chemistry
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.

Release the package to conda-forge

Follow Conda | example workflow for updating a package for the panel-chemistry-feedstock.

Remember to

conda install -c conda-forge conda-smithy
conda smithy rerender -c auto

Remember to update the SHA! You can find it on Pypi