├── .gitignore
├── README.md
├── _extensions
└── quarto-ext
│ └── shinylive
│ ├── _extension.yml
│ ├── resources
│ └── css
│ │ └── shinylive-quarto.css
│ └── shinylive.lua
├── _quarto.yml
├── _quarto_demo
├── .gitignore
├── .jupyter_cache
│ ├── __version__.txt
│ ├── executed
│ │ ├── 9672b08ff1ddea2951e5ae728051ef7c
│ │ │ └── base.ipynb
│ │ ├── b50cfc38d21a52788890accc928b92ad
│ │ │ └── base.ipynb
│ │ └── da58f06eb7d9f3d3818e1ed9cec24628
│ │ │ └── base.ipynb
│ └── global.db
├── _quarto.yml
├── annotation.qmd
├── basics.ipynb
├── cell-options.qmd
├── msword.ipynb
├── palmer-penguins.csv
├── pdf.ipynb
├── presentation.ipynb
└── references.bib
├── about.qmd
├── gha.qmd
├── icon.png
├── index.qmd
├── nbdev.png
├── photos
├── hamel.jpeg
├── jj.png
└── wasim.jpeg
├── quarto_demo
└── styles.css
/.gitignore:
--------------------------------------------------------------------------------
1 | /.quarto/
2 | _site/
3 | .ipynb_checkpoints
4 | /.luarc.json
5 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # JupyterCon 2023 nbdev Tutorial
2 |
3 | Materials for [Write, Document, Test and Distribute Python Packages With Jupyter & Quarto](https://cfp.jupytercon.com/2023/talk/ZRS7CW/), JupyterCon 2023.
4 |
5 | ## Course Website
6 |
7 | [https://fastai.github.io/jupytercon-2023/](https://fastai.github.io/jupytercon-2023/)
8 |
--------------------------------------------------------------------------------
/_extensions/quarto-ext/shinylive/_extension.yml:
--------------------------------------------------------------------------------
1 | name: shinylive
2 | title: Embedded Shinylive applications
3 | author: Winston Chang
4 | version: 0.0.3
5 | quarto-required: ">=1.2.198"
6 | contributes:
7 | filters:
8 | - shinylive.lua
9 |
--------------------------------------------------------------------------------
/_extensions/quarto-ext/shinylive/resources/css/shinylive-quarto.css:
--------------------------------------------------------------------------------
1 | div.output-content,
2 | div.shinylive-wrapper {
3 | background-color: rgba(250, 250, 250, 0.65);
4 | border: 1px solid rgba(233, 236, 239, 0.65);
5 | border-radius: 0.5rem;
6 | box-shadow: 0px 1px 2px rgba(0, 0, 0, 0.04), 0px 3px 7px rgba(0, 0, 0, 0.04),
7 | 0px 12px 30px rgba(0, 0, 0, 0.07);
8 | margin-top: 32px;
9 | margin-bottom: 32px;
10 | }
11 |
12 | div.shinylive-wrapper {
13 | margin: 1em 0;
14 | border-radius: 8px;
15 | }
16 |
17 | .shinylive-container {
18 | background-color: #eeeff2;
19 | min-height: auto;
20 | }
21 |
22 | .shinylive-container > div {
23 | box-shadow: none;
24 | }
25 |
26 | .editor-container .cm-editor .cm-scroller {
27 | font-size: 13px;
28 | line-height: 1.5;
29 | }
30 |
31 | iframe.app-frame {
32 | /* Override the default margin from Bootstrap */
33 | margin-bottom: 0;
34 | }
35 |
--------------------------------------------------------------------------------
/_extensions/quarto-ext/shinylive/shinylive.lua:
--------------------------------------------------------------------------------
1 | local hasDoneShinyliveSetup = false
2 | local codeblockScript = nil
3 |
4 | -- Try calling `pandoc.pipe('shinylive', ...)` and if it fails, print a message
5 | -- about installing shinylive package.
6 | function callShinylive(args, input)
7 | local res
8 | local status, err = pcall(
9 | function()
10 | res = pandoc.pipe("shinylive", args, input)
11 | end
12 | )
13 |
14 | if not status then
15 | print(err)
16 | error("Error running 'shinylive' command. Perhaps you need to install the 'shinylive' Python package?")
17 | end
18 |
19 | return res
20 | end
21 |
22 |
23 | -- Do one-time setup when a Shinylive codeblock is encountered.
24 | function ensureShinyliveSetup()
25 | if hasDoneShinyliveSetup then
26 | return
27 | end
28 | hasDoneShinyliveSetup = true
29 |
30 | -- Find the path to codeblock-to-json.ts and save it for later use.
31 | codeblockScript = callShinylive({ "codeblock-to-json-path" }, "")
32 | -- Remove trailing whitespace
33 | codeblockScript = codeblockScript:gsub("%s+$", "")
34 |
35 | local baseDeps = getShinyliveBaseDeps()
36 | for idx, dep in ipairs(baseDeps) do
37 | quarto.doc.add_html_dependency(dep)
38 | end
39 |
40 | quarto.doc.add_html_dependency(
41 | {
42 | name = "shinylive-quarto-css",
43 | stylesheets = {"resources/css/shinylive-quarto.css"}
44 | }
45 | )
46 | end
47 |
48 |
49 | function getShinyliveBaseDeps()
50 | -- Relative path from the current page to the root of the site. This is needed
51 | -- to find out where shinylive-sw.js is, relative to the current page.
52 | if quarto.project.offset == nil then
53 | error("The shinylive extension must be used in a Quarto project directory (with a _quarto.yml file).")
54 | end
55 | local depJson = callShinylive(
56 | { "base-deps", "--sw-dir", quarto.project.offset },
57 | ""
58 | )
59 |
60 | local deps = quarto.json.decode(depJson)
61 | return deps
62 | end
63 |
64 |
65 | return {
66 | {
67 | CodeBlock = function(el)
68 | if el.attr and el.attr.classes:includes("{shinylive-python}") then
69 | ensureShinyliveSetup()
70 |
71 | -- Convert code block to JSON string in the same format as app.json.
72 | local parsedCodeblockJson = pandoc.pipe(
73 | "quarto",
74 | { "run", codeblockScript },
75 | el.text
76 | )
77 |
78 | -- This contains "files" and "quartoArgs" keys.
79 | local parsedCodeblock = quarto.json.decode(parsedCodeblockJson)
80 |
81 | -- Find Python package dependencies for the current app.
82 | local appDepsJson = callShinylive(
83 | { "package-deps" },
84 | quarto.json.encode(parsedCodeblock["files"])
85 | )
86 |
87 | local appDeps = quarto.json.decode(appDepsJson)
88 |
89 | for idx, dep in ipairs(appDeps) do
90 | quarto.doc.attach_to_dependency("shinylive", dep)
91 | end
92 |
93 | el.attr.classes = pandoc.List()
94 | el.attr.classes:insert("shinylive-python")
95 | return el
96 | end
97 | end
98 | }
99 | }
100 |
--------------------------------------------------------------------------------
/_quarto.yml:
--------------------------------------------------------------------------------
1 | project:
2 | type: website
3 | resources: ["nbdev.png"]
4 |
5 | website:
6 | title: "nbdev Tutorial: JupyterCon 2023"
7 | favicon: icon.png
8 | description: "A nbdev + Quarto tutorial for JupyterCon 2023."
9 | image: nbdev.png
10 | open-graph: true
11 | repo-url: https://github.com/fastai/jupytercon-2023
12 | repo-actions: [edit]
13 | repo-branch: main
14 | site-url: "https://fastai.github.io/jupytercon-2023/"
15 | navbar:
16 | left:
17 | - about.qmd
18 |
19 | format:
20 | html:
21 | theme: flatly
22 | css: styles.css
23 | toc: true
24 |
25 |
26 |
27 |
--------------------------------------------------------------------------------
/_quarto_demo/.gitignore:
--------------------------------------------------------------------------------
1 | /.quarto/
2 |
--------------------------------------------------------------------------------
/_quarto_demo/.jupyter_cache/__version__.txt:
--------------------------------------------------------------------------------
1 | 0.6.1
--------------------------------------------------------------------------------
/_quarto_demo/.jupyter_cache/global.db:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fastai/jupytercon-2023/5089ea28b991d5577542973669524306f42b75b1/_quarto_demo/.jupyter_cache/global.db
--------------------------------------------------------------------------------
/_quarto_demo/_quarto.yml:
--------------------------------------------------------------------------------
1 | project:
2 | type: website
3 |
4 | execute:
5 | enabled: true
6 |
7 | filters:
8 | - shinylive
--------------------------------------------------------------------------------
/_quarto_demo/annotation.qmd:
--------------------------------------------------------------------------------
1 | ---
2 | title: "Code Annotation"
3 | format: html
4 | jupyter: python3
5 | ---
6 |
7 | ```{python}
8 | word_index = imdb.get_word_index() # <1>
9 | reverse_word_index = dict(
10 | [(value, key) for (key, value) in word_index.items()]) # <2>
11 | decoded_review = ' '.join(
12 | [reverse_word_index.get(i - 3, '?') for i in train_data[0]]) # <3>
13 | ```
14 |
15 | 1. `word_index` is a dictionary mapping words to an integer index
16 |
17 | 2. Reverses it, mapping integer indices to words
18 |
19 | 3. Decodes the review. Note that the indices are offset by 3 because 0, 1, and 2 are reserved indices for "padding", "start of sequence" and "unknown".
--------------------------------------------------------------------------------
/_quarto_demo/basics.ipynb:
--------------------------------------------------------------------------------
1 | {
2 | "cells": [
3 | {
4 | "cell_type": "markdown",
5 | "id": "7ee42dc7-c6a5-44fa-8190-b620caabb32b",
6 | "metadata": {},
7 | "source": [
8 | "# Palmer Penguins"
9 | ]
10 | },
11 | {
12 | "cell_type": "raw",
13 | "id": "be5165b9-6b3e-4868-9234-d10f7d04a6bc",
14 | "metadata": {},
15 | "source": [
16 | "---\n",
17 | "author: Norah Jones\n",
18 | "date: March 22, 2023\n",
19 | "---"
20 | ]
21 | },
22 | {
23 | "cell_type": "code",
24 | "execution_count": 1,
25 | "id": "6308a322-b23c-443a-888e-ce91b205555b",
26 | "metadata": {
27 | "tags": []
28 | },
29 | "outputs": [
30 | {
31 | "data": {
32 | "text/html": [
33 | "\n",
34 | "\n",
47 | "
\n",
48 | " \n",
49 | " \n",
50 | " | \n",
51 | " species | \n",
52 | " island | \n",
53 | " year | \n",
54 | " sex | \n",
55 | " bill_length_mm | \n",
56 | " bill_depth_mm | \n",
57 | "
\n",
58 | " \n",
59 | " \n",
60 | " \n",
61 | " | 0 | \n",
62 | " Adelie | \n",
63 | " Torgersen | \n",
64 | " 2007 | \n",
65 | " male | \n",
66 | " 39.1 | \n",
67 | " 18.7 | \n",
68 | "
\n",
69 | " \n",
70 | " | 1 | \n",
71 | " Adelie | \n",
72 | " Torgersen | \n",
73 | " 2007 | \n",
74 | " female | \n",
75 | " 39.5 | \n",
76 | " 17.4 | \n",
77 | "
\n",
78 | " \n",
79 | " | 2 | \n",
80 | " Adelie | \n",
81 | " Torgersen | \n",
82 | " 2007 | \n",
83 | " female | \n",
84 | " 40.3 | \n",
85 | " 18.0 | \n",
86 | "
\n",
87 | " \n",
88 | " | 3 | \n",
89 | " Adelie | \n",
90 | " Torgersen | \n",
91 | " 2007 | \n",
92 | " NaN | \n",
93 | " NaN | \n",
94 | " NaN | \n",
95 | "
\n",
96 | " \n",
97 | " | 4 | \n",
98 | " Adelie | \n",
99 | " Torgersen | \n",
100 | " 2007 | \n",
101 | " female | \n",
102 | " 36.7 | \n",
103 | " 19.3 | \n",
104 | "
\n",
105 | " \n",
106 | "
\n",
107 | "