PyPI package to write Markdown document directly from a Python script
Project description
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
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
markdownpy-0.1.4.tar.gz
(7.7 kB
view details)
Built Distribution
File details
Details for the file markdownpy-0.1.4.tar.gz
.
File metadata
- Download URL: markdownpy-0.1.4.tar.gz
- Upload date:
- Size: 7.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.10.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | a5a43e62a8ca044ccdcc10d08d23f1f7766fa64a8e4417a09af34e4744c6f3e0 |
|
MD5 | 3a4ba9b915ff18674a9f164978629f21 |
|
BLAKE2b-256 | 34c25d91b172c2118f43ad39c97aaea5f22de5281179d23408d04311bf2af38e |
File details
Details for the file markdownpy-0.1.4-py3-none-any.whl
.
File metadata
- Download URL: markdownpy-0.1.4-py3-none-any.whl
- Upload date:
- Size: 8.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.10.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 504cf2673a9aad43430db100eccb9fcdd25ad5ad5a531c4bae82f180a62d9e13 |
|
MD5 | 615965d2f0ff7602b6f91318aef38c27 |
|
BLAKE2b-256 | 56e821e7c956220784f80abd8d8b6c994c2b1dc4111907c1d019ab2a073a76af |