template-uv-python-research-software/src/notebooks/example_notebook.ipynb.jinja at 01de82fb05698e9a5a871e5c7f887744531ff902 · d33bs/template-uv-python-research-software · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
{
 "cells": [
  {
   "cell_type": "markdown",
   "id": "a614a0d9-50be-4975-bffb-a67281f665a4",
   "metadata": {},
   "source": [
    "# An example notebook\n",
    "\n",
    "Sharing how a notebook can work in combination with a Python package.\n",
    "\n",
    "Notes:\n",
    "- [`jupytext`](https://github.com/mwouts/jupytext) helps us automatically\n",
    "export the notebook through `pyproject.toml` configuration.\n",
    "This makes it easier to provide line-level comments within pull\n",
    "request reviews or to use the Python file independent of the notebook.\n",
    "- [`jupyterlab_code_formatter`](https://github.com/jupyterlab-contrib/jupyterlab_code_formatter)\n",
    "helps automatically format the notebook on-the-fly using black, isort, and\n",
    "more so that our notebook has a consistent and readable format\n",
    "(including as we develop it!). This extension is available through the\n",
    "browser-based Juypyter interface\n",
    "as a circular button near the top of each notebook.\n",
    "Clicking it applies the formatting to the notebook."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 1,
   "id": "e6794389-4a05-470b-9434-a4fa2191a40b",
   "metadata": {},
   "outputs": [],
   "source": [
    "# show an import from a local package\n",
    "from {{ python_package_name }} import show_message"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 4,
   "id": "9ea05787-98f5-4887-8e90-7506b1cbcc64",
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/html": [
       "<div>\n",
       "<style scoped>\n",
       "    .dataframe tbody tr th:only-of-type {\n",
       "        vertical-align: middle;\n",
       "    }\n",
       "\n",
       "    .dataframe tbody tr th {\n",
       "        vertical-align: top;\n",
       "    }\n",
       "\n",
       "    .dataframe thead th {\n",
       "        text-align: right;\n",
       "    }\n",
       "</style>\n",
       "<table border=\"1\" class=\"dataframe\">\n",
       "  <thead>\n",
       "    <tr style=\"text-align: right;\">\n",
       "      <th></th>\n",
       "      <th>message</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>0</th>\n",
       "      <td>Hello, notebook!</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "</div>"
      ],
      "text/plain": [
       "            message\n",
       "0  Hello, notebook!"
      ]
     },
     "execution_count": 4,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "# use the function within the notebook to show it works\n",
    "show_message(\"Hello, notebook!\")"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3 (ipykernel)",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.11.11"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 5
}