-
-
Notifications
You must be signed in to change notification settings - Fork 516
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
3f9324f
commit 3940168
Showing
6 changed files
with
50 additions
and
0 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
# Configure PyCharm | ||
|
||
This guide addresses how to configure PyCharm for an efficient Panel development workflow. | ||
|
||
We assume you have a basic understanding of [working with Python projects in PyCharm](https://www.jetbrains.com/help/pycharm/creating-and-running-your-first-python-project.html), including running and [debugging](https://www.jetbrains.com/help/pycharm/debugging-python-code.html) Python applications. | ||
|
||
:::{note} | ||
In the following, we assume you have already created a Python project, installed Panel, and other requirements, and created your Panel file. | ||
::: | ||
|
||
--- | ||
|
||
## Serve from the Terminal | ||
|
||
You can use `panel serve` to serve apps from the PyCharm terminal, just as you would with in any other terminal. | ||
|
||
![Panel Serve in Terminal](../../_static/images/pycharm-serve-panel.png) | ||
|
||
## Run/Debug Configurations | ||
|
||
To learn how to configure PyCharm in general, check out [the official guide](https://www.jetbrains.com/help/pycharm/run-debug-configuration.html). | ||
|
||
To enable you to run and debug Panel apps in PyCharm, you should create a configuration as shown below: | ||
|
||
![Configure PyCharm for Panel](../../_static/images/pycharm-configure-panel.png) | ||
|
||
- Configuration Name: `panel serve` | ||
- Module Name: `panel` | ||
- Parameters: `serve $FilePath$` | ||
- Working Directory: The path to your *project root* | ||
|
||
### Run | ||
|
||
With the configuration in place, you can now easily `run` Panel apps via the `panel serve` configuration. | ||
|
||
![Run Panel App in PyCharm](../../_static/images/pycharm-run-panel.png) | ||
|
||
### Debug | ||
|
||
With the configuration in place, you can now easily `debug` Panel apps via the `panel serve` configuration. The picture below shows debugging in action, where a breakpoint is hit when the Button is clicked. | ||
|
||
![Debug Panel App in PyCharm](../../_static/images/pycharm-debug-panel.png) |