Skip to content

Commit 1d72fb1

Browse files
Add setup instructions for GitHub package registry
Signed-off-by: Andy Jakubowski <hello@andyjakubowski.com>
1 parent 017e92f commit 1d72fb1

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,22 @@ Install `jupyterlab`. The extension package itself doesn’t depend on `jupyterl
7272
uv pip install jupyterlab
7373
```
7474

75+
**Configure Access to @deepnote/blocks Package**
76+
77+
The `@deepnote/blocks` package is published on GitHub Packages. To install it, you'll need to authenticate with GitHub:
78+
79+
1. Create a GitHub Personal Access Token (classic) with `read:packages` scope:
80+
- Go to https://github.com/settings/tokens
81+
- Click "Generate new token (classic)"
82+
- Select the `read:packages` scope
83+
- Generate and copy the token
84+
85+
2. Set the `GITHUB_TOKEN` environment variable to ensure `jlpm` (which is a wrapper around Yarn) can download the `@deepnote/blocks` package from the GitHub package registry. You can set the variable in `.zshrc` or manually like:
86+
```shell
87+
export GITHUB_TOKEN=your_token_here
88+
```
89+
Replace `YOUR_TOKEN_HERE` with your actual token.
90+
7591
Install the extension package in editable mode. It installs the package’s dependencies, too:
7692

7793
```shell

0 commit comments

Comments
 (0)