Merge pull request #117 from geoffbeier/4-dj-notebook-document-pycharm

Document how to install dj-notebook in PyCharm Professional.
pydanny · Oct 19, 2023 · b14360e · b14360e
2 parents 5fdd60a + 119817c
commit b14360e
Show file tree

Hide file tree

Showing 6 changed files with 36 additions and 0 deletions.
diff --git a/docs/img/pycharm/add_package.png b/docs/img/pycharm/add_package.png
diff --git a/docs/img/pycharm/create_notebook.png b/docs/img/pycharm/create_notebook.png
diff --git a/docs/img/pycharm/install_dj-notebook.png b/docs/img/pycharm/install_dj-notebook.png
diff --git a/docs/img/pycharm/interpreter_menu.png b/docs/img/pycharm/interpreter_menu.png
diff --git a/docs/img/pycharm/notebook_working.png b/docs/img/pycharm/notebook_working.png
diff --git a/docs/pycharm.md b/docs/pycharm.md
@@ -0,0 +1,36 @@
+# Using dj-notebook with PyCharm
+
+PyCharm Professional has built-in integration for Jupyter notebooks. This integration works well with dj-notebook once your jupyter and dj-notebook are added to your existing Django project's virtual environment.
+
+## Quick Start
+
+1. Open your existing django project in pycharm.
+2. Make sure that pycharm's interpreter is configured for your project's virtual environment.
+3. Add dj-notebook and jupyter to that virtual environment.
+4. Create a new notebook and load your django settings in the first cell.
+5. Execute that cell to launch the Jupyter server.
+
+## Adding dj-notebook to your Virtual Environment
+
+![PyCharm Interpreter Menu](img/pycharm/interpreter_menu.png)
+
+Once pycharm has loaded your django project, you can inspect the virtual environment used by the project's interpreter by using the interpreter menu in the lower right corner of the project window. Click on the current interpreter (1) then choose "Interpreter Settings..." to to confirm the location of the virtual environment and see which packages are loaded there.
+
+If jupyter and dj-notebook are not already installed, you can add them from the IDE by clicking the add button then searching for dj-notebook:
+
+![PyCharm - Add package](img/pycharm/add_package.png)
+
+Then click "Install Package":
+
+![PyCharm - Install dj-notebook](img/pycharm/install_dj-notebook.png)
+
+## Using dj-notebook Within PyCharm's Integrated Notebook View
+
+Once dj-notebook is installed, you can create a new notebook from within the project explorer:
+
+![PyCharm - Create new notebook](img/pycharm/create_notebook.png)
+
+In the new notebook, when you execute your first cell, PyCharm will start the Jupyter server and display the results inline. Once the server is started, dj-notebook [just works, as described in the usage guide](https://dj-notebook.readthedocs.io/en/latest/usage/). PyCharm's notebook interface [is documented here](https://www.jetbrains.com/help/pycharm/jupyter-notebook-support.html#ui).
+
+![PyCharm - working notebook](img/pycharm/notebook_working.png)
+