How to use the Github Markdown API using Python

Question

I'm trying to use the Github Markdown API to turn Markdown files into pretty HTML files but I can't seem to get the API to work.

I've been using requests.post with payloads exactly as detailed in the documentation here and I've tried changing a few things but nothing seems to return the HTML that I want.

Here is the code I'm using:

import requests

with open("index.md", "r") as markdown, open("index.html", "w") as html:
    payload = {"text": markdown.read(), "mode": "markdown"}
    html.write(requests.post("https://api.github.com/markdown", data=payload).text)

The return from the Github API is the following:

{
    "message": "Problems parsing JSON",
    "documentation_url": "https://developer.github.com/v3/markdown/#render-an-arbitrary-markdown-document"
}

where an HTML version of my document is expected back.

Anson Biggs · Accepted Answer · 2019-06-13 21:15:15Z

3

Since the API was expecting json the request should have been:

html.write(requests.post("https://api.github.com/markdown", json=payload).text)

Which uses json instead of data to send the payload with the post request.

answered Jun 13, 2019 at 21:15

Anson Biggs

3711 gold badge4 silver badges16 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

How to use the Github Markdown API using Python

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related