This repository can be cloned to follow the API workshop proposed by Deltablot.

You can open and run notebooks with Jupyter on your computer (OPTION 1) or use Google Colab (OPTION 2).

To run the notebooks locally, you will need:

• A terminal (Terminal on Linux/macOS, or WSL on Windows)
• git installed

If git is not installed, see: https://git-scm.com/downloads

If you don’t want to use the terminal, you can use the Google Colab option instead.

We will use uv to manage dependencies, see installation instructions: https://github.com/astral-sh/uv?tab=readme-ov-file#installation

Open a terminal and run the following commands:

# Clone the repository on your computer
git clone https://github.com/elabftw/api-workshop.git

# Get into the folder
cd api-workshop

# Install dependencies with uv
uv sync --frozen

# Start Jupyterlab
uv run jupyter lab

If you have followed the above commands, a new window will have opened in your browser, entitled JupyterLab.

In case it did not open, you can also access it directly at: http://localhost:8888/.

(this only affects the eLabFTW screenshots; the notebook content is in English)

You now only need your eLabFTW instance and the Jupyter notebook open. You can close this page for better readability.

You can use Google Colab to open and run the Jupyter notebooks without installing anything locally.

To open and browse the notebooks with Google Colab, you will need a Google account.

Note: If you are not logged in, you will be redirected to the “Welcome to Google Colab” page. Log in, then reopen the link above to access the search page.

In the the search bar, type: elabftw/api-workshop and press enter

• Getting started: https://doc.elabftw.net/tutorials/api-workshop
• Api specification documentation: https://doc.elabftw.net/api/v2/
• Python library repository: https://github.com/elabftw/elabapi-python
• HTML documentation: https://doc.elabftw.net/api/elabapi-html/