How to get started with nbdev, with special guest Hamel Husain. We show, from scratch, how to build a complete Python project including documentation website, modules, pip installer, README, etc.

(Another version of this video is available with the silent sections sped up using the `unsilence` python library - it's 27 mins shorter: https://youtu.be/67FdzLSt4aA)

00:00 - Welcome
04:39 - Turn a github repo into a nbdev repo
06:48 - What are nbdev commands?
08:17 - How to find out the docs of a nbdev command
08:37 - What does nbdev_new give us?
10:54 How should you name ipynbs for your library
15:32 - What does the heading 1 and heading 2 do?
18:02 - Create a Card module
19:01 - Creating suits
21:23 - Creating a class
26:54 - How to overwrite the __str__ and __repr__
29:03 - How to write docs for input argument
33:13 - Create tests for the class
37:06 - How to define equality
38:32 - How to define a function outside of a class
42:18 - How to export your Card py file with nbdev_export
48:33 - How to preview your documentation
55:02 - How to do local test
56:52 - How to do debugging in real life
1:00:51 - Which cells should be exported with #|export
1:02:09 - Creating Deck module
1:06:41 - How to overwrite the __len__ and __contains__
1:15:22 - Automatic links
1:18:48 - Creating a function
1:21:50 - Pushing back to github
1:27:21 - run nbdev_docs to put the homepage inside README.md
1:28:47 - Release Your Library
1:30:16 - How nbdev makes PR easier for all

Timestamps based on notes by Daniel 深度碎片 on forums.fast.ai.

Jeremy Howard

The post provides a tutorial on how to use nbdev, a tool that allows you to create complete software packages from Jupyter notebooks. It covers steps from setting up a new project, creating software packages, generating documentation, and setting up continuous integration and deployment through GitHub Actions. By the end of the tutorial, readers will have a functional example project with CI, documentation, and a Python package ready for distribution.

nbdev tutorial -- zero to published project in 90 minutes