Today, we are going to show you how to set up a literate programming environment, allowing you to use an IDE (VS Code) and an interactive computing environment (Jupyter), without leaving your browser, for free, in under 5 minutes. You’ll even see how VSCode and Jupyter work together automatically! But first, what is literate programming? And how did I got from a skeptic to a big fan of literate programming in a month?
Literate programming is a programming paradigm introduced by Donald Knuth in which a computer program is given an explanation of its logic in a natural language, such as English, interspersed with snippets of macros and traditional source code, from which compilable source code can be generated. According to Knuth, literate programming provides higher-quality programs by forcing programmers to explicitly state the thoughts behind the program. This process makes poorly thought-out design decisions more obvious. Knuth also claims that literate programming provides a first-rate documentation system, which is not an add-on, but is grown naturally in the process of exposition of one’s thoughts during a program’s creation. 1
When I first learned about literate programming, I was quite skeptical. For the longest time, I had wrongly equated Jupyter notebooks with literate programming. Indeed, Jupyter is a brilliant interactive computing system, which was awarded the Association of Computing Machinery (ACM) Software System Award, and is loved by many developers. However, Jupyter falls short of the literate programming paradigm for the following reasons:2
- It can be difficult to compile source code from notebooks.
- It can be difficult to diff and use version control with notebooks because they are not stored in plain text.
- It is not clear how to automatically generate documentation from notebooks.
- It is not clear how to properly run tests suites when writing code in notebooks.
My skepticism quickly evaporated when I began using nbdev, a project that extends notebooks to complete the literate programming ideal. I spent a month, full time, using nbdev while contributing to the python library fastcore, and can report that Donald Knuth was definitely onto something. The process of writing prose and tests alongside code forced me to deeply understand why the code does what it does, and to think deeply about its design. Furthermore, the reduced cognitive load and speed of iteration of having documentation, code, and tests in one location boosted my productivity to levels I have never before experienced as a software developer. Furthermore, I found that developing this way bolstered collaboration such that code reviews not only happened faster but were more meaningful. In short, nbdev may be the most profound productivity tool I have ever used.
As a teaser, look how easy it is to instantiate this literate programming environment, which includes a notebook, a docs site and an IDE with all dependencies pre-installed!
Features of nbdev
As discussed in the docs, nbdev provides the following features:
- Searchable, hyperlinked documentation, which can be automatically hosted on GitHub Pages for free.
- Python modules, following best practices such as automatically defining
__all__with your exported functions, classes, and variables.
- Pip and Conda installers.
- Tests defined directly in notebooks which run in parallel. This testing system has been thoroughly tested with GitHub Actions.
- Navigate and edit your code in a standard text editor or IDE, and export any changes automatically back into your notebooks.
Since you are in a notebook, you can also add charts, text, links, images, videos, etc, that are included automatically in the documentation of your library, along with standardized documentation generated automatically from your code. This site is an example of docs generated automatically by nbdev.
Thanks to Conda and nbdev_template, setting up a development environment with nbdev is far easier than it used to be. However, we realized it could be even easier, thanks to a new GitHub product called Codespaces. Codespaces is a fully functional development environment in your browser, accessible directly from GitHub, that provides the following features:
- A full VS Code IDE.
- An environment that has files from the repository mounted into the environment, along with your GitHub credentials.
- A development environment with dependencies pre-installed, backed by Docker.
- The ability to serve additional applications on arbitrary ports. For nbdev, we serve a Jupyter notebook server as well as a Jekyll based documentation site.
- A shared file system, which facilitates editing code in one browser tab and rendering the results in another.
- … and more.
Codespaces enables developers to immediately participate in a project without wasting time on DevOps or complicated setup steps. Most importantly, CodeSpaces with nbdev allows developers to quickly get started with creating their own software with literate programming.
A demo of nbdev + Codespaces
This demo uses the project fastai/fastcore, which was built with nbdev, as an example. First, we can navigate to this repo and launch a Codespace:
If you are launching a fresh Codespace, it may take several minutes to set up. Once the environment is ready, we can verify that all dependencies we want are installed (in this case
Additionally, we can serve an arbitrary number of applications on user-specified ports, which we can open through VSCode as shown below:
In this case, these applications are a notebook and docs site. Changes to a notebook are reflected immediately in the data docs. Furthermore, we can use the cli command
nbdev_build_lib to sync our notebooks with python modules. This functionality is shown below:
This is amazing! With a click of a button, I was able to:
- Launch an IDE with all dependencies pre-installed.
- Launch two additional applications: a Jupyter Notebook server on port 8080 and a docs site on port 4000.
- Automatically update the docs and modules every time I make a change to a Jupyter notebook.
This is just the tip of the iceberg. There are additional utilities for writing and executing tests, diffing notebooks, special flags for hiding, showing, and collapsing cells in the generated docs, as well as git hooks for automation. This and more functionality is covered in the nbdev docs.
Give It A Try For Yourself
To try out nbdev yourself, take this tutorial, which will walk you through everything you need to know. The tutorial also shows you how to use a repository template with the configuration files necessary to enable Codespaces with nbdev.
You Can Write Blogs With Notebooks, Too!
- The GitHub Codepaces site.
- The official docs for Codespaces.
- The nbdev docs.
- The nbdev GitHub repo.
- fastpages: The project used to write this blog.
- The GitHub repo fastai/fastcore, which is what we used in this blog post as an example.