Jupyter notebook to Markdown
Turn a Jupyter notebook (.ipynb) into Markdown: text cells as they are, code and its output as code blocks. Reads the cells of a notebook in order and writes them as one Markdown text. Made for giving a notebook to a language model, or for reading one without Jupyter.
Input
Result
Choose a file and press Run.
Files you upload and the results are stored for one hour, then deleted. Anyone who has the link can open them, so don't upload anything private.
Use it from code or an agent
# 1. Upload the file. The reply ends with a line "ref <id>/f1": that is the file reference.
curl -T sample.ipynb https://setget.net/drop/
# 2. Run the tool with that reference. "wait" holds the reply for up to 30 seconds while the job runs.
curl -s https://setget.net/v1/tools/ipynb-to-markdown \
-H 'Content-Type: application/json' \
-d '{"input":{"file":"DROP_ID/f1"},"wait":30}'
# 3. The reply is {"tool", "ms", "result", "files": [{"name", "size", "url", "ref"}], "job"}.
# Download a result file from its "url", or pass its "ref" to another tool.
# Still running after the wait? The reply is 202 with "job": follow it with
# curl -s https://setget.net/v1/jobs/JOB_ID?wait=30
import json, urllib.parse, urllib.request
BASE = "https://setget.net"
def call(method, path, body=None, headers=None):
request = urllib.request.Request(BASE + path, body, headers or {}, method=method)
return json.load(urllib.request.urlopen(request))
def upload(path):
"""Step 1: upload a file and get its reference."""
name = path.replace("\\", "/").rsplit("/", 1)[-1]
with open(path, "rb") as handle:
reply = call("PUT", "/drop/" + urllib.parse.quote(name), handle.read(), {"Accept": "application/json"})
return reply["file"]["ref"]
# Step 2: run the tool with the reference.
body = {"input": {'file': upload("sample.ipynb")}, "wait": 30}
reply = call("POST", "/v1/tools/ipynb-to-markdown", json.dumps(body).encode(), {"Content-Type": "application/json"})
# Step 3: a job that is still running comes back as {"job": ...}. Wait for it.
while "result" not in reply and reply.get("job", reply).get("status") in ("queued", "running"):
reply = call("GET", "/v1/jobs/" + reply.get("job", reply)["id"] + "?wait=30")
if "error" in reply:
raise SystemExit(reply["error"]["message"])
print(reply["result"])
for file in reply["files"]: # result files: download from "url", or pass "ref" to another tool
print(file["name"], file["size"], file["url"], file["ref"])
const BASE = "https://setget.net";
// Step 1: upload a file and get its reference. file: a File or Blob
// (in Node: new Blob([fs.readFileSync(path)])).
async function upload(file, name) {
const response = await fetch(`${BASE}/drop/${encodeURIComponent(name)}`, {
method: "PUT", headers: {Accept: "application/json"}, body: file,
});
return (await response.json()).file.ref;
}
// Step 2: run the tool with the reference.
let reply = await (await fetch(`${BASE}/v1/tools/ipynb-to-markdown`, {
method: "POST",
headers: {"Content-Type": "application/json"},
body: JSON.stringify({input: {"file":await upload(file, "sample.ipynb")}, wait: 30}),
})).json();
// Step 3: a job that is still running comes back as {job}. Wait for it.
while (!reply.result && ["queued", "running"].includes((reply.job || reply).status)) {
reply = await (await fetch(`${BASE}/v1/jobs/${(reply.job || reply).id}?wait=30`)).json();
}
if (reply.error) throw new Error(reply.error.message);
console.log(reply.result);
for (const file of reply.files) console.log(file.name, file.size, file.url, file.ref);
1. Upload. Tool: drop
Arguments:
{
"action": "create",
"files": [
{
"name": "sample.ipynb",
"size": "<bytes>"
}
]
}
PUT each file's bytes to its "upload.url" with the listed headers, and keep its "ref".
With a shell, one command does both: curl -T FILE https://setget.net/drop/
2. Run. Tool: run_tool
Arguments:
{
"slug": "ipynb-to-markdown",
"input": {
"file": "DROP_ID/f1"
}
}
3. The answer holds "result" and "files" (each with "url" and "ref").
If it holds a "job" that is still running instead, follow it. Tool: job
Arguments:
{
"action": "wait",
"id": "JOB_ID"
}
{
"input": {
"file": "DROP_ID/f1"
},
"wait": 30
}
This is a file tool, so a call takes three steps: upload the file to get a reference, run the tool with that reference, then read the result and download its files. Uploads and results are public by link and expire after one hour.
Endpoint: POST /v1/tools/ipynb-to-markdown. Over MCP: run_tool with slug: "ipynb-to-markdown".
Machine-readable: input schema, Markdown. Connect an agent.
Inputs
| Name | Type | Required | What it does |
|---|---|---|---|
file |
file | yes | The Jupyter notebook (.ipynb) to convert. In the API: a file reference such as DROP_ID/f1. Accepts: text, binary. |
outputs |
boolean | no | Include what the code cells printed and returned. Default: true. |
Examples
A notebook with code and output
{
"file": "sample.ipynb"
}Press the example button above to run it on the sample file.
Text and code only
{
"file": "sample.ipynb",
"outputs": false
}Press the example button above to run it on the sample file.
Questions
- How are cells written?
- Markdown cells are copied as they are. Code cells become code blocks marked with the language of the notebook. Each output follows its code under the word "Output:".
- What happens to plots and pictures?
- They are left out and counted in the result. Markdown holds text only.
- What about tables from pandas?
- A table in an output becomes a Markdown table.
- Are long outputs cut?
- Each output is cut at 10,000 characters, with a line saying how much was left out. Colour codes and overwritten progress lines are removed.
- Is the code run?
- No. The notebook is only read.
- Where is the Markdown?
- In a file named after your upload, ending in .md. The result also holds the Markdown itself in "markdown" when it is up to 200,000 characters; "truncated" is true when only the start fits there.
- Does it fetch anything from the internet?
- No. Links and picture addresses found in the file are copied as text. Nothing they point to is opened or downloaded.
Conversions this tool does
Related tools
- Anything to MarkdownTurn almost any document into Markdown: PDF, Word, PowerPoint, Excel, HTML, EPUB, e-mail, notebooks, CSV.
any-to-markdown - HTML to MarkdownTurn a saved web page into Markdown: the main content, without menus, scripts and styling.
html-to-markdown - Markdown to HTMLConvert Markdown to clean HTML, with tables, task lists and code blocks, as a fragment or a full page.
markdown-to-html - Code to imageTurn source code into a shareable picture with syntax highlighting, a window frame and a choice of themes.
code-image - Compress a PDFMake a PDF file smaller by packing its contents tighter and, if you allow it, re-saving its pictures at a lower resolution.
pdf-compress - E-mail to MarkdownTurn a saved e-mail (.eml) into Markdown: who, when and subject, the message text, and a list of attachments.
eml-to-markdown