Skip to content

1. Install NodeKit

This tutorial walks through how to install NodeKit on your system.

NodeKit is a Python library. It is installed using the uv Python package and project manager.

Quick install for uv users

If you already know how to use uv and have it on your system, navigate to the directory containing the Python project where you'd like to install NodeKit. Then run:

uv add nodekit
Installation with pip

If you prefer to use pip, and know how to manage your virtual environments and pyproject.toml file, you can also run:

pip install nodekit

Step 1: Install uv

Follow the uv installation guide, if you don't already use uv on your system.

You can confirm uv is successfully installed by running the following command in your terminal: 

uv --version

The terminal should print out a version number, like this: 

uv 0.8.12 (36151df0e 2025-08-18)

Step 2: Start a Python project for the tutorial code

  1. Navigate to any directory where you'd like to house a folder containing the NodeKit tutorial code.
  2. Run the following command in your terminal: 
    uv init nodekit-tutorial
    You should see a new directory called "nodekit-tutorial" containing a pyproject.toml file, a main.py file, and a README.md file appear.
PyCharm user?

If you're a PyCharm user, you can follow the instructions here to start a new Python project using uv without touching the terminal.

Step 3: Install nodekit

Ensure you are in the directory containing the pyproject.toml file (from the previous step, this should be the nodekit-tutorial directory). Then, run the following command in the terminal: 

uv add nodekit

You should see the console report that a virtual environment created, and that several Python packages have been installed.

To verify that everything worked:

  1. Run the following command in your terminal: 
    uv run python
    An interactive Python console should appear in your terminal.
  2. Type the following command into the Python console: 
    import nodekit as nk

If the above worked with no error messages popping up, you've successfully installed NodeKit!