DEVELOPER_GUIDE.md

❤️ Developer Guide

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

🧳 Prerequisites

• A working Python environment.
• Git CLI.
• uv

📙 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/panel-mermaid.git
cd panel-mermaid
uv venv
source .venv/bin/activate # linux
uv pip install -e .[examples,dev,test]

You can run all tests via

ruff check
pytest tests

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

Serve the Examples

panel serve examples/app_*.py --dev

🚢 Release a new package on Pypi

Update the version in the pyproject.toml.

Then run all tests as described above

Then you can build

uv build

and publish by setting your UV_PUBLISH_TOKEN and running

uv publish

to publish the package 📦.