Build from Source

python-template-jupyter is written in Python and JavaScript. While prebuilt wheels are provided for end users, it is also straightforward to build python-template-jupyter from either the Python source distribution or the GitHub repository.

• Make commands
• Prerequisites
• Clone
• Install Python dependencies
• Build
• Lint and Autoformat
• Testing

Make commands

As a convenience, python-template-jupyter uses a Makefile for commonly used commands. You can print the main available commands by running make with no arguments

> make

build                          build the library
clean                          clean the repository
fix                            run autofixers
install                        install library
lint                           run lints
test                           run the tests

Prerequisites

python-template-jupyter has a few system-level dependencies which you can install from your machine package manager. Other package managers like conda, nix, etc, should also work fine.

Clone

Clone the repo with:

git clone https://github.com/python-project-templates/python-template-jupyter.git
cd python-template-jupyter

Install NodeJS

Follow the instructions for installing NodeJS for your system. Once installed, you can install pnpm with:

npm install --global pnpm

Install Python dependencies

Python build and develop dependencies are specified in the pyproject.toml, but you can manually install them:

make requirements

Note that these dependencies would otherwise be installed normally as part of PEP517 / PEP518.

Build

Build the python project in the usual manner:

make build

Lint and Autoformat

python-template-jupyter has linting and auto formatting.

Language	Linter	Autoformatter	Description
Python	ruff	ruff	Style
Python	ruff	ruff	Imports
JavaScript	prettier	prettier	Style
Markdown	mdformat	mdformat	Style
Markdown	codespell		Spelling

Python Linting

make lint-py

Python Autoformatting

make fix-py

JavaScript Linting

make lint-js

JavaScript Autoformatting

make fix-js

Documentation Linting

make lint-docs

Documentation Autoformatting

make fix-docs

Testing

python-template-jupyter has both Python and JavaScript tests. The bulk of the functionality is tested in Python, which can be run via pytest. First, install the Python development dependencies with

make develop

Python

make test-py

JavaScript

make test-js