🚪 Awesome Panel CLI Intro

THIS PROJECT IS IN AN ALPHA STATE AND WILL CHANGE. USE IT AT YOUR OWN RISK.

The aim of the awesome-panel-cli project is to turn you into a rockstar developer of high quality data apps.

To do this the awesome-panel-cli provides an opinionated command line interface (CLI) pn and a set of best practice templates.

For example you can install and create a new app as simple as

pip install awesome-panel-cli[all]
pn create app

This project draws inspiration from other CLI tools like

• Angular CLI.
• Django management commands
• django-simple-deploy
• React Create App

This project is a part of the awesome-panel project. Please support the awesome-panel project by giving it a ⭐ at awesome-panel/awesome-panel.

Thanks

Contributing

If you are looking to contribute you can find ideas in the issue tracker.

I would ❤️ to support and receive your contributions. Thanks.

.

🧳 Prerequisites

• A working Python environment.
• Git CLI.

📙 How to

Below we describe how to get started.

🚀 Install for usage

You can install the package via

pip install awesome-panel-cli

If you additionally want to serve the intro notebook or example apps you should run

pip install awesome-panel-cli[all]

You will then have access to a powerful command line interface invoked using the command pn.

How to figure out which commands are available

Try running

pn --help

pn hello --help

pn create --help

pn create app --help

pn create project --help

💻 Install for Development

To install for development you will need a fresh and activated virtual 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 before you git push and fix any failing tests.

🔥 Install the current master branch

If you want to try out or test the newest features you can install the current master branch via

pip install pip -U
pip install git+https://github.com/awesome-panel/awesome-panel-cli.git