markmodule

Import python from markdown files.

Markdown is a hammer, everything is a nail

You can use markdown:

• as a place to put module code, markmodule, this library

The do-everything-with-markdown ecosystem is surprisingly robust.

• as a Makefile alternative, mask
• as a place to put scripts, eg python's markdown-exec, or ruby's markdown_exec
• as a place to put unit tests, pytest-markdown-docs, pytest-codeblocks, and pytest-markdown
• as a string template, proof-of-concept gist

Usage

In a file named hello_module.mdm define a function. I'm escaping the fence, use a real three tick fence.

Here is a function

``(`)python
def some_function(args: str) -> str:
    """This is a function that does something."""
    return "Hello World" + args
``(`)

And some more documentation 

Import. Your IDE will not recognize the module, but it will work at runtime.

import markmodule
markmodule.import_md("hello_module.md")
import hello_module

print(hello_module.some_function("yo!"))

Change Log

• 0.1.0 - Basic idea.
• 0.2.0 - Updates to readme

Documentation

• Contributing
• TODO
• Related StackOverflow Links