Build the Turing Way Book Locally

Build the Turing Way Book Locally#

But why build locally?#

It’s always handy to be able to preview any changes you have been working on as you go - you can be confident that changes you have made are accurate and as intended. A nice way to do this is to use the underlying Jupyter Book tool to build the book locally.

This is useful because it allows you to preview any changes you have made on your local machine before you push your changes to a remote branch. You can then decide if you are happy with the result and push your changes to the remote branch thus helping to keep Pull Request conversations and commit histories a bit cleaner.

Step-by-step guide#

We will be using the command line throughout this guide. You will need to locate your “terminal” or “prompt” application on your machine.

Install miniconda by following the instructions for your Operating System (Windows, MacOS, Linux) at this link: https://conda.io/projects/conda/en/latest/user-guide/install/index.html#regular-installation
Open your terminal app and run the conda init command in your terminal. You should see (base) in your prompt indicating that conda was successfully installed and you are now in its base environment.
- Note that if you are using Windows, you will need to open a program called Anaconda prompt instead of using cmd.
Create a new environment and install a modern version of Python into it:
```
conda create --name the-turing-way python=3.8
```
Activate the environment with:
```
conda activate the-turing-way
```
Any commands we run with Python or pip from now on will use the versions of Python and pip installed into this conda env, not any others.
Clone The Turing Way repository from GitHub to your machine using the command:
```
git clone https://github.com/the-turing-way/the-turing-way
```
Note

To address potential barriers with slow internet connections due to the large size of this repository, you can use partial clones. Specifically, focusing on blobless clones, which are efficient for developers, involves utilizing the --filter=blob:none option in the git clone command.

By using --filter=blob:none, the initial git clone operation downloads all reachable commits and trees, while blobs (file contents) for commits are only downloaded when performing a git checkout

Here’s the command to use blobless clones:
```
git clone --filter=blob:none https://github.com/the-turing-way/the-turing-way.git
```
Navigate into the cloned repository folder using the command cd the-turing-way, where the cd command means change directory.
Then change into the sub-directory the website is built from using cd book/website
The Turing Way book is built using multiple python libraries. We can install these dependencies into your conda environment using the following command
```
pip install -r requirements.txt
```
where the requirements.txt file contains a list of python libraries
And now build the book:
```
jupyter-book build .
```

The output of the build process will provide output such as below that demonstrate how you can view the book locally:

===============================================================================

Finished generating HTML for book.
Your book's HTML pages are here:
    _build/html/
You can look at your book by opening this file in a browser:
    _build/html/index.html
Or paste this line directly into your browser bar:
    file:///[...]/the-turing-way/the-turing-way/book/website/_build/html/index.html

===============================================================================

Build the book while working on a Pull Request#

If you would like to preview a version of the book from a certain branch (perhaps to render the book while working on a PR) then simply switch to the required branch and rebuild the book as in step 9:

git checkout mybranch
jupyter-book build .

Follow the link as before and you will see changes specific to that branch rendered.

Clean up a recent build#

When you test your edits by building the book multiple times, it is better to clean up the last build before generating a new one. You can either manually delete the book/website/_build folder every time, or run this command:

cd book/website
jupyter-book clean .

More details on this process can be read in Jupyter Book’s documentation.

Check external links in the book#

When editing or reviewing this book locally, you can run the Sphinx link checker with Jupyter Book to check if the external links mentioned in the book are valid. To run the link checker, use the following command:

cd book/website
jupyter-book build . --builder linkcheck

The link checker checks if the each link resolves and prints the status on your terminal so that you can check and resolve any incorrect links. Read more about this in Jupyter Book’s documentation.

Why did we recommend using (mini)conda?#

In the step-by-step guide above, we made use of the jupyter-book command to build the Turing Way book. For this command to work as intended you will need a Python installation on your machine. As with any other programming language such as R or Julia, any given Python installation might look different from another due to the different packages or libraries that come with the installation. Over time you will likely install even more packages, or update packages to newer versions. Some packages also depend on the presence of specific versions of other packages to function, and so to ensure your local build works smoothly you will want to minimize as much mismatched dependencies as possible.

But this can be difficult! Even with an organized, concerted effort, package management for programming languages naturally throws up dependency issues. Python packages, for reasons not discussed here, tend to suffer from dependency issues a bit more than other languages (note that all languages do!) and one guaranteed way to come across such an issue by trying to maintain all of your Python projects using just one, large set of packages, each at a specific version. You simply can’t cater to the needs of all package dependencies this way.

A humorous, black and white flowchart from XKCD depicting the complexity of managing different Python environments on a computer. It shows a tangled web of arrows and lines connecting various versions of Python installed through different methods such as Homebrew, Anaconda, and binaries from Python.org. There are also references to different tools and paths like PIP, PYTHONPATH, and system PATH, that add to the confusion. The paths weave in and out of local folders on a computer. Some of them are noted to be owned by root, making them harder to manage. The illustration is annotated with bemused and perplexed comments about the state of the Python environment, concluding with a comic punchline at the bottom that reads, "My Python environment has become so degraded that my laptop has been declared a superfund site." — Fig. 157 Illustration from xkcd describing the complexities of installing different versions of Python on your computer. Used under a CC-BY-NC 2.5 licence.#

The most relevant feature for us here is virtual environments.

conda is a package manager designed to easily create language agnostic virtual environments, where each environment contains their own separate set of packages that don’t interfere with each other. In fact it is best practice to create a virtual environment for each project you work on. We could just use Python’s built in virtualenv tool to do this, but it doesn’t extend into a multi-language env like conda offers.

By creating a separate environment on your local machine just for The Turing Way, this is a great way to minimize those dependency issues. conda also has community run channels that dedicate their time to providing you with a certain pool of packages that may be relevant to a specific project, for example the Bioconda channel that contains packages relevant for bioinformatics projects, and packages not necessarily found on the default channel. Other example channels are:

r
conda-forge
tensorflow-macos

These carefully curated channels also help to ensure your virtual environments contain the most appropriate packages for each of your projects.