observablehq / observablehq/notebook-kit
Download private notebook
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 371
- Forks
- 27
- Avg merge
- 3h 52m
- Merged PRs (30d)
- 1
Description
The notebooks download command doesn't support private notebooks. I tried modifying https://github.com/observablehq/notebook-kit/blob/main/bin/download.ts to include an API key that I use for downloading notebook JS (e.g. https://api.observablehq.com/NOTEBOOK_URI.js?v=3&api_key=123456) and it looks like the https://api.observablehq.com/document/ API doesn't support API keys. Is there an existing solution that I'm missing or can you add API key support to the document endpoint?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with bin/download.ts and trace how the notebooks download command requests the document/ API and handles credentials. Verify the behavior for a private notebook using the API key format described in the issue; done means the command can download private notebooks through the supported authentication path.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api, authentication, cli
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100