Skip to main content
Latest Version Travis CI Status

Overview

This project allows you to translate markdown to HTML and to convert URLs or even local image file-paths to embedded images.

Local file-paths must be specifically enabled, for security reasons.

This project is Python 2 and Python 3 compatible.

Example

Image URLs

Short usage:

import mei

markdown = "![Random Ingenuity](http://www.randomingenuity.com/ri72.png)"
actual = mei.markdown(markdown)

# <p><img src="data:image/png;base64,iVBORw0KGgoAAAANSU...kJggg==" alt="Random Ingenuity"></p>

Long usage:

import mei.embed_images
import mistune

renderer = mei.embed_images.EmbedImagesRenderer()
m = mistune.Markdown(renderer=renderer)

markdown = "![Random Ingenuity](http://www.randomingenuity.com/ri72.png)"
actual = m.render(markdown)

# <p><img src="data:image/png;base64,iVBORw0KGgoAAAANSU...kJggg==" alt="Random Ingenuity"></p>

Local Images

Short usage:

import mei

markdown = "![alt text](/drawable-mdpi/ic_menu_paste.png)"
actual = mei.markdown(markdown)

# <p><img src="data:image/png;base64,iVBORw0KGgoAAAANSU...TkSuQCC" alt="Random Ingenuity"></p>

Long usage:

import mei.embed_images
import mistune

renderer = mei.embed_images.EmbedImagesRenderer(embed_local_images=True)
m = mistune.Markdown(renderer=renderer)

markdown = "![alt text](/drawable-mdpi/ic_menu_paste.png)"
actual = m.render(markdown)

# <p><img src="data:image/png;base64,iVBORw0KGgoAAAANSU...TkSuQCC" alt="Random Ingenuity"></p>

Testing

Just run the test script:

$ ./test.sh
test_embed_images_local (test_embed_images.TestEmbedImages) ... ok
test_embed_images_url (test_embed_images.TestEmbedImages) ... ok
test_get_base64_with_image_filepath (test_embed_images.TestEmbedImages) ... ok
test_get_base64_with_image_url (test_embed_images.TestEmbedImages) ... ok
test_get_embedded_image_filepath (test_embed_images.TestEmbedImages) ... ok
test_get_embedded_image_filepath__xhtml (test_embed_images.TestEmbedImages) ... ok
test_get_embedded_image_url (test_embed_images.TestEmbedImages) ... ok
test_get_embedded_image_url__xhtml (test_embed_images.TestEmbedImages) ... ok
test_get_http2 (test_embed_images.TestEmbedImages) ... ok
test_get_http3 (test_embed_images.TestEmbedImages) ... ok
test_http (test_embed_images.TestEmbedImages) ... ok
test_http__instance_cached (test_embed_images.TestEmbedImages) ... ok
test_markdown (test_embed_images.TestEmbedImages) ... ok

----------------------------------------------------------------------
Ran 13 tests in 0.016s

OK

Release files for markdown-embedimages 0.1.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for markdown-embedimages 0.1.4
File Size Uploaded
markdown-embedimages-0.1.4.tar.gz 3.9 kB Details

Release files / markdown-embedimages-0.1.4.tar.gz

Download URL markdown-embedimages-0.1.4.tar.gz
Size 3.9 kB
Tags Source
SHA-256 checksum
How to use checksums
8b5d6eb8b6232e16d17039219b64c32a34ca13eedf9d036e6ba7663c7ad012b3
BLAKE2b-256 checksum
How to use checksums
837b2d76d87407abb854f1244dccdf1795b559d83eed9e2ef4f34a95be19faae
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.1.4 This release

1 release file

0.1.3

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page