Skip to main content

Convert a Jupyter notebook to blog ready format

Project description

Notebook to Blog


Notebook to Blog is a Python CLI that makes it easy to go from a Jupyter Notebook to the following outputs:

  • A .txt file containing blog text and placeholders
  • Images of plots (saved locally)
  • Github Gists

While not completely automated, this will make it much easier to create a blog post (e.g., Medium).


  1. Install via pip install notebook-to-blog.
  2. Store your Github username/password somewhere in your filesystem:
  1. Run via notebook_to_blog <path to Jupyter notebook> <path to output directory> <path to Github credentials>

For example, running notebook_to_blog my_notebook.ipynb output .env will create the following files:


In addition, Github Gists will be created for each code block encountered.

my_notebook.txt looks like the following:

Whatever you wrote in Markdown will appear as regular text. Code blocks will cause Github Gists to be created, and a link to be inserted:

Images will also be represented as placeholder text:

<INSERT img_04.png>

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

notebook-to-blog-0.0.1.tar.gz (3.6 kB view hashes)

Uploaded source

Built Distribution

notebook_to_blog-0.0.1-py3-none-any.whl (6.1 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page