Astral SDK Location Protocol Jupyter Notebook

An interactive tutorial environment for learning the Astral SDK and Location Protocol Framework using Deno as a Jupyter kernel.

This project demonstrates how to create cryptographically verifiable location attestations using modern JavaScript and TypeScript in a notebook-driven, interactive workflow.

Project Structure

.
├── README.md              
├── pyproject.toml         # Python project configuration (uv-managed)
├── deno.json              # Deno configuration with imports and tasks
├── .gitignore             
├── .venv/                 
└── notebooks/             # Jupyter notebook Guided Tutorials
    └── utils/             # Utility modules and helper methods for notebooks

Prerequisites

Before running setup, ensure you have installed:

1. Deno (v1.37+)

Deno is a modern JavaScript/TypeScript runtime with built-in Jupyter support.

macOS/Linux:

curl -fsSL https://deno.land/x/install/install.sh | sh

Windows (PowerShell):

irm https://deno.land/install.ps1 | iex

Verify installation:

deno --version

See Deno Installation Guide for alternatives.

2. uv (optional but recommended)

This project uses uv as the Python package installer and virtual environment manager.

macOS/Linux:

curl -LsSf https://astral.sh/uv/install.sh | sh

Windows (PowerShell):

irm https://astral.sh/uv/install.ps1 | iex

Or via Homebrew (macOS):

brew install uv

Verify installation:

uv --version

See uv Installation Guide for more options.

Setup Python Environment and Deno Kernel

1. Create Python Virtual Environment

Minimum Python version required is 3.12.0

uv venv .venv

2. Activate Virtual Environment

macOS / Linux:

source .venv/bin/activate

Windows:

.venv\Scripts\activate

3. Install Python Dependencies

uv sync

or alternatively:

pip install .

This installs all dependencies listed in pyproject.toml, including JupyterLab.

4. Install Deno Jupyter Kernel

deno jupyter --unstable --install

You'll see output confirming kernel installation:

[InstallKernelSpec] Installed kernelspec deno
✅ Deno kernelspec installed successfully.

Running the Notebooks

Start JupyterLab

jupyter lab

or with the through deno

deno run jupyter

JupyterLab will open in your default browser at http://localhost:8888.

Verify Setup

In your first notebook cell, run:

console.log("Deno Jupyter kernel ready ✅");
Deno.version;

To test Astral SDK availability, in a cell run:

import { AstralSDK } from "https://esm.sh/@decentralized-geo/astral-sdk";

// Or alternatively, importing and saving to a variable
const astral = await Promise.all([import("https://esm.sh/@decentralized-geo/astral-sdk")]);

// You can then import specific modules from the `astral` variable
const { AstralSDK } = astral;

Common Deno Tasks

Format and Lint Code

deno task format
deno task lint

Check TypeScript Types

deno task check

Add a New Deno Dependency

Update deno.json manually, or use:

deno add jsr:@package/name

Resources

Deno & Jupyter

• Deno Documentation
• Deno Jupyter Kernel Documentation
• Bringing Modern JavaScript to Jupyter

Astral SDK & Location Protocol

• Astral SDK Documentation
• Astral SDK GitHub
• Location Protocol Specification

License

See LICENSE file in the repository.