Skip to main content

Create Markdown from a Python program

Project description

markdown-builder

markdown-builder is a minimalist package for creating MarkDown documents in a Python program.

It requires Python 3.

It grew out of a number of Python applications that needed similar functionality. At present, it only supports the features required by those applications, but I'm open to suggestions for additions.

The DRY principle led me to separate out the code into a separate package.

With markdown-builder you can build a Markdown document in a few lines of Python code.

Installation

pip3 install markdown-builder.

Quickstart

The following Python program will generate SAMPLE.md

from markdown_builder.document import MarkdownDocument

md = MarkdownDocument()
md.append_heading('Welcome to MarkDown')
md.append_text('markdown-builder is really easy to use')
md.append_heading('This is a level2 heading', 2)
md.append_text_indented('This is inset', depth=1)
md.append_bullet('This is a top-level bullet point')
md.append_bullet('This is a lower level bullet point', depth=1)

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

markdown-builder-0.1.2.tar.gz (3.2 kB view details)

Uploaded Source

Built Distribution

markdown_builder-0.1.2-py3-none-any.whl (3.7 kB view details)

Uploaded Python 3

File details

Details for the file markdown-builder-0.1.2.tar.gz.

File metadata

  • Download URL: markdown-builder-0.1.2.tar.gz
  • Upload date:
  • Size: 3.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.10

File hashes

Hashes for markdown-builder-0.1.2.tar.gz
Algorithm Hash digest
SHA256 389bc534edf42b9b8a04c530477180dce970b82191e7c3d9821f27957235edbb
MD5 0c614819e00bce26d78aa55785d62f7f
BLAKE2b-256 46cc21b91361b37ebdf0c414be97a080abb844b218f6b091cef380c0ac267126

See more details on using hashes here.

File details

Details for the file markdown_builder-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: markdown_builder-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 3.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.10

File hashes

Hashes for markdown_builder-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 47a947494c63dc9676055ad2b5b58721661d9174df250425fa8ee5e926d06c87
MD5 5c711fb18663c72a02b1f582591aa2fb
BLAKE2b-256 6dee1791f495cb2333d4bd944d1e1514508b39e0894d4b076fa59900abbf6236

See more details on using hashes here.

Supported by

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