Skip to main content

PyPi version License Black code style

Markdownpy

Simple Python package to write Markdown document directly from a Python script.

Install

Locally

Clone the repository install it with pip:

git clone git@github.com:aidanjungo/Markdownpy.git
cd Markdownpy
pip install -e .

From PyPi

You can install the last version of Markdownpy with pip:

pip install markdownpy

Usage

You can import and use the package in any Python script and use it to generate result or documentation files on the fly.

from markdownpy.markdownpy import MarkdownDoc

md = MarkdownDoc("MySimpleMarkdown.md")

md.h1("H1 title")
md.h2("H2 title")
md.p("paragraph")

md.h2("Lists")

mylist = []
for i in range(5):
    mylist.append(f"item_{i}")

md.blist(mylist)

md.save()

From more example, checkout example.py

By the way, this README has been generated using Markdownpy, you can see the python script here: readme.py

Metadata

Release files for markdownpy 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 markdownpy 0.1.4
File Size Uploaded
markdownpy-0.1.4.tar.gz 7.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for markdownpy 0.1.4
File Interpreter ABI Platform
markdownpy-0.1.4-py3-none-any.whl Python 3 none any Details

Total release size: 15.8 kB

Release files / markdownpy-0.1.4.tar.gz

Download URL markdownpy-0.1.4.tar.gz
Size 7.7 kB
Tags Source
SHA-256 checksum
How to use checksums
a5a43e62a8ca044ccdcc10d08d23f1f7766fa64a8e4417a09af34e4744c6f3e0
BLAKE2b-256 checksum
How to use checksums
34c25d91b172c2118f43ad39c97aaea5f22de5281179d23408d04311bf2af38e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.10.7

Release files / markdownpy-0.1.4-py3-none-any.whl

Download URL markdownpy-0.1.4-py3-none-any.whl
Size 8.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
504cf2673a9aad43430db100eccb9fcdd25ad5ad5a531c4bae82f180a62d9e13
BLAKE2b-256 checksum
How to use checksums
56e821e7c956220784f80abd8d8b6c994c2b1dc4111907c1d019ab2a073a76af
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.10.7

Release history Release notifications | RSS feed

This release

0.1.4 This release

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

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