❤️ Developer Guide

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

🧳 Prerequisites

Below we describe how to install and use this project 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-cli.git
cd awesome-panel-cli
pip install pip -U
pip install -e .[all]

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.

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.