{"id":129504,"date":"2022-11-05T11:41:55","date_gmt":"2022-11-05T11:41:55","guid":{"rendered":"https:\/\/blog.finxter.com\/?p=860752"},"modified":"2022-11-05T11:41:55","modified_gmt":"2022-11-05T11:41:55","slug":"working-with-markdown-files-in-python","status":"publish","type":"post","link":"https:\/\/sickgaming.net\/blog\/2022\/11\/05\/working-with-markdown-files-in-python\/","title":{"rendered":"Working with Markdown Files in Python"},"content":{"rendered":"\n
\n
\n
\n
\n
<\/div>\n<\/p><\/div>\n
\n
<\/div>\n<\/p><\/div>\n
\n
<\/div>\n<\/p><\/div>\n
\n
<\/div>\n<\/p><\/div>\n
\n
<\/div>\n<\/p><\/div>\n<\/p><\/div>\n
\n
\n
<\/div>\n<\/p><\/div>\n
\n
<\/div>\n<\/p><\/div>\n
\n
<\/div>\n<\/p><\/div>\n
\n
<\/div>\n<\/p><\/div>\n
\n
<\/div>\n<\/p><\/div>\n<\/p><\/div>\n<\/div>\n
5\/5 – (1 vote) <\/div>\n<\/div>\n

This article will show you how to create and work with markdown files using Python.<\/p>\n

\"\ud83d\udca1\" Markdown is an excellent tool with many features to spice up a flat-text file, such as changing text colors, adding bullet points, tables, and much more. A terrific way to add pizzazz to an otherwise dull file.<\/p>\n

To make it more interesting, we have the following running scenario:<\/p>\n

\n
\"\"<\/figure>\n<\/div>\n

Acme Spinners, manufacturer of the Spinner Widgets, has contacted you to create a README.md file for their software. They would like you to format the flat-text file to make it easier to navigate and more professional. <\/em><\/p>\n

Each section of this article builds on the previous one. In the end, an entire README.md<\/code> file will be created.<\/p>\n

\n

\"\ud83d\udcac\" Question<\/strong>: How would we write code to create and populate an md file?<\/em><\/p>\n

We can accomplish this task by performing the following steps:<\/p>\n

    \n
  1. Install Required Library<\/li>\n
  2. Create a Python File<\/li>\n
  3. Create a Markdown File<\/li>\n
  4. Preview Markdown File<\/li>\n
  5. Add Logo Image<\/li>\n
  6. Add a Paragraph<\/li>\n
  7. Add Heading<\/li>\n
  8. Add Table<\/li>\n
  9. Add Bullet Points<\/li>\n
  10. Add Table of Contents<\/li>\n<\/ol>\n
    \n

    Install Required Library<\/h2>\n

    Before running the code in this article, the mdutils<\/code><\/a> library must be installed.<\/p>\n

    To install this library, navigate to the command prompt and run the following code.<\/p>\n

    pip install mdutils<\/pre>\n
    This library contains tools to assist in the creation of markdown files in Python, transforming a bland flat-text file into a fantastic-looking one!<\/p>\n
    \n
    Create Python File<\/h2>\n
    Let’s start by creating a Python file called acme.py<\/code> and placing this file into the current working directory. <\/p>\n
    In the IDE, navigate to and open acme.py<\/code> and add the following lines.<\/p>\n
    from mdutils.mdutils import MdUtils\nfrom mdutils import Html<\/pre>\n
    These lines allow access to and manipulation of markdown features.<\/p>\n
    Save this file.<\/p>\n
    \n
    Create a Markdown File<\/h2>\n
    The next step is to create a markdown file. <\/p>\n
    Open the acme.py<\/code> file created earlier. At this point, this file should only contain two (2) lines of code.<\/p>\n
    from mdutils.mdutils import MdUtils\nfrom mdutils import Html<\/pre>\n
    The following code snippet appends two (2) additional lines to acme.py<\/code>.<\/p>\n
    The first highlighted line calls the Mdutils()<\/code><\/a> function and passes one (1) argument: a filename. This creates an object and saves it to mdAcme<\/code>. If output to the terminal, an object similar to the one below would display.<\/p>\n
    <mdutils.mdutils.MdUtils object at 0x00000257FEB64940><\/code><\/pre>\n
    from mdutils.mdutils import MdUtils\nfrom mdutils import Html mdAcme = MdUtils(file_name='acme') mdAcme.create_md_file()<\/pre>\n
    The following line appends the create_md_file()<\/code><\/a> function to the mdAcme<\/code> object. When this code is run, the acmd.md<\/code> file is created and saved to the current working directory.<\/p>\n
    Typically, the above line is only called once all the file contents have been finalized. From hereon in, all additional code will be placed above this line.<\/p>\n
    Save the acme.py<\/code> file.<\/p>\n
    \"\ud83d\udca1\"Note<\/strong>: A file extension is not required when passing a filename to the Mdutils()<\/code><\/a> function. By default, md <\/code>is assumed.<\/p>\n
    \n
    Preview a Markdown File<\/h2>\n
    During the progression of our markdown file, we can preview the file in our IDE. These instructions assume you are using the VSC<\/a> IDE.<\/p>\n
    In the IDE, hover over the acme.md<\/code> file and right-mouse click. This action displays a pop-up. <\/p>\n
    \n
    \"\"<\/figure>\n<\/div>\n
    From this pop-up, select Open Preview (or CTRL+SHIFT+V<\/code>). This action displays a preview of the acme.md<\/code> file. At this point, there is no data to display.<\/p>\n
    \n
    \"\"<\/figure>\n<\/div>\n
    No worries! We’ll fix this in the next sections!<\/p>\n
    \"\ud83d\udca1\"Note<\/strong>: Depending on the IDE, the Preview option may differ.<\/p>\n
    \n
    Add Logo Image<\/h2>\n
    Let’s add a logo to the top of the Markdown file. Save the logo at the top of this article and place it in the current working directory.<\/p>\n
    There are two (2) ways to add an image. <\/p>\n
    Option 1:<\/strong> Use new_line()<\/code><\/a><\/p>\n
    The highlighted line calls the new_line()<\/code><\/a> function, which adds a new line to the file. Then, new_inline_image()<\/code><\/a> is called and passed one (1) argument: path (the full path to the image). <\/p>\n
    from mdutils.mdutils import MdUtils\nfrom mdutils import Html mdAcme = MdUtils(file_name='acme')\nmdAcme.new_line(mdAcme.new_inline_image(path='as_logo.png')) mdAcme.create_md_file()<\/pre>\n
    Update acme.py<\/code>, save and run.<\/p>\n
    If we preview acme.md<\/code>, the logo displays on a new line (size: 411×117) and is left-aligned.<\/p>\n
    \"\"<\/figure>\n
    Option 2:<\/strong><\/p>\n
    To change the image size and\/or alignment, use the Html. image()<\/code><\/a> function.<\/p>\n
    from mdutils.mdutils import MdUtils\nfrom mdutils import Html mdAcme = MdUtils(file_name='acme')\nmdAcme.new_paragraph(Html.image(path='as_logo.png', size='250', align='center')) mdAcme.create_md_file()<\/pre>\n
    The highlighted line calls the new_paragraph()<\/code><\/a> function, which adds a new line to the file. Then, Html_image()<\/a><\/code> is called and passed three (3) arguments: path<\/code> (image location\/name), size <\/code>(image size) and align<\/code> (image alignment).<\/p>\n
    Update acme.py<\/code>, save and run.<\/p>\n
    If we preview acme. md<\/code>, the logo displays in its modified size and is center-aligned.<\/p>\n
    \n
    \"\"<\/figure>\n<\/div>\n
    For this article, Option 2 is used.<\/p>\n
    \n
    Add a Paragraph<\/h2>\n
    Earlier, new_paragraph()<\/code><\/a> was used to add a logo. However, we can also use this to add plain text. Let’s add a new paragraph.<\/p>\n
    The highlighted line creates a new string. This string is formatted to bold, italics and is center-aligned.<\/p>\n
    from mdutils.mdutils import MdUtils\nfrom mdutils import Html mdAcme = MdUtils(file_name='acme')\nmdAcme.new_paragraph(Html.image(path='as_logo.png', size='250', align='center'))\nmdAcme.new_paragraph('License and Installation Instructions', bold_italics_code='bi', align='center') mdAcme.create_md_file()<\/pre>\n
    Update acme.py<\/code>, save and run.<\/p>\n
    If we preview acme.md<\/code>, the paragraph displays in bold italics and is center-aligned.<\/p>\n
    \n
    \"\"<\/figure>\n<\/div>\n
    \n
    Add Heading and Text<\/h2>\n
    A Level 1 Heading (level=1<\/code>) called Overview and text is added.<\/p>\n
    In the highlighted area below, an Overview section is created. <\/p>\n
    This section shows how to use the write()<\/code><\/a> and new_paragraph()<\/code><\/a> functions to display text, change text colors and add hyperlinks.<\/p>\n
    from mdutils.mdutils import MdUtils\nfrom mdutils import Html mdAcme = MdUtils(file_name='acme')\nmdAcme.new_paragraph(Html.image(path='as_logo.png', size='250', align='center'))\nmdAcme.new_paragraph('License and Installation Instructions', bold_italics_code='bi', align='center') mdAcme.new_header(level=1, title='Overview')\nmdAcme.write(\"Welcome to <font color='red'>Acme Spinners<\/font>!\\n\\n\")\nmdAcme.new_paragraph(\"Visit our website at <a href='#'>acmespinners.ca<\/a> to view our videos on the latest spinner techniques.\\n\") mdAcme.create_md_file()<\/pre>\n
    Update acme.py<\/code>, save and run.<\/p>\n
    If we preview acme.md<\/code>, the Overview heading and text displays.<\/p>\n
    \n
    \"\"<\/figure>\n<\/div>\n
    Let’s open acme.md<\/code> to review the code when not in Preview Mode. <\/p>\n
    Notice that the code in the acme.py<\/code> file was converted to HTML.<\/p>\n
    \n
    \"\"<\/figure>\n<\/div>\n
    \"\ud83d\udca1\"Note<\/strong>: If you are unfamiliar with HTML, click here<\/a> to learn more!<\/p>\n
    \n
    Add Table<\/h2>\n
    A Level 2 Heading (level=2<\/code>) called License, and a table is added.<\/p>\n
    In the highlighted area below, a License section was created. <\/p>\n
    This section displays details about the license in a table format. This example adds a line for each entry. However, a loop could also be used to populate the table.<\/p>\n
    from mdutils.mdutils import MdUtils\nfrom mdutils import Html mdAcme = MdUtils(file_name='acme')\nmdAcme.new_paragraph(Html.image(path='as_logo.png', size='250', align='center'))\nmdAcme.new_paragraph('License and Installation Instructions', bold_italics_code='bi', align='center') mdAcme.new_header(level=1, title='Overview')\nmdAcme.write(\"Welcome to <font color='red'>Acme Spinners<\/font>!\\n\\n\")\nmdAcme.new_paragraph(\"Visit our website at <a href='#'>acmespinners.ca<\/a> to view our videos on the latest spinner techniques.\\n\") mdAcme.new_header(level=2, title='License')\ndata = [\"Item\", \"Description\"]\ndata.extend([\"License #\", \"ACS-3843-34-2217\"])\ndata.extend([\"Purchase Date\", \"Nov. 1, 2022\"])\ndata.extend([\"\", \"\"])\nmdAcme.new_table(columns=2, rows=4, text=data, text_align='left')\nmdAcme.new_line()<\/pre>\n
    Update, save and run the acme.py<\/code> file.<\/p>\n
    If we preview acme.md<\/code>, the following displays.<\/p>\n
    \n
    \"\"<\/figure>\n<\/div>\n
    \n
    Add Bullet Points<\/h2>\n
    A Level 3 Heading (level=3<\/code>) called Instructions, and two (2) sets of bullet points are added.<\/p>\n
    from mdutils.mdutils import MdUtils\nfrom mdutils import Html mdAcme = MdUtils(file_name='acme')\nmdAcme.new_paragraph(Html.image(path='as_logo.png', size='250', align='center'))\nmdAcme.new_paragraph('License and Installation Instructions', bold_italics_code='bi', align='center') mdAcme.new_header(level=1, title='Overview')\nmdAcme.write(\"Welcome to <font color='red'>Acme Spinners<\/font>!\\n\\n\")\nmdAcme.new_paragraph(\"Visit our website at <a href='#'>acmespinners.ca<\/a> to view our videos on the latest spinner techniques.\\n\") mdAcme.new_header(level=2, title='License')\ndata = [\"Item\", \"Description\"]\ndata.extend([\"License #\", \"ACS-3843-34-2217\"])\ndata.extend([\"Purchase Date\", \"Nov. 1, 2022\"])\ndata.extend([\"\", \"\"])\nmdAcme.new_table(columns=2, rows=4, text=data, text_align='left') mdAcme.new_header(level=3, title='Instructions')\nlist1 = ['Getting Started', 'Remove Battery', ['Add 2 AAA Batteries', 'Close and lock']]\nmdAcme.new_list(list1)\nlist2 = ['1. Set Level', ['1. Scroll to view levels', '2. Press Select'], '2. Press Start', ]\nmdAcme.new_list(list2) mdAcme.create_md_file()<\/pre>\n
    Update, save and run the acme.py<\/code> file.<\/p>\n
    If we preview acme.md<\/code>, the following displays.<\/p>\n
    \"\"<\/figure>\n
    \"\ud83d\udca1\"Note<\/strong>: There are additional ways to configure bullet points. For this article, the most commonly used was selected.<\/p>\n
    \n
    Add a Table of Contents<\/h2>\n
    This sections combines the three (3) headings created earlier (different level for each) and from these lines, creates a Table of Contents.<\/p>\n
    On the highlighted line, the Table of Contents is created. For this function, a title (‘Table of Contents<\/code>‘), and depth (3<\/code>) was passed. <\/p>\n
    A depth of 3 was selected as each heading in this article was assigned a different level (example, level=1<\/code>, level=2, level=3<\/code>).<\/p>\n
    from mdutils.mdutils import MdUtils\nfrom mdutils import Html mdAcme = MdUtils(file_name='acme')\nmdAcme.new_paragraph(Html.image(path='as_logo.png', size='250', align='center'))\nmdAcme.new_paragraph('License and Installation Instructions', bold_italics_code='bi', align='center') mdAcme.new_header(level=1, title='Overview')\nmdAcme.write(\"Welcome to <font color='red'>Acme Spinners<\/font>!\\n\\n\")\nmdAcme.new_paragraph(\"Visit our website at <a href='#'>acmespinners.ca<\/a> to view our videos on the latest spinner techniques.\\n\") mdAcme.new_header(level=2, title='License')\ndata = [\"Item\", \"Description\"]\ndata.extend([\"License #\", \"ACS-3843-34-2217\"])\ndata.extend([\"Purchase Date\", \"Nov. 1, 2022\"])\ndata.extend([\"\", \"\"])\nmdAcme.new_table(columns=2, rows=4, text=data, text_align='left') mdAcme.new_header(level=3, title='Instructions')\nlist1 = ['Getting Started', 'Remove Battery', ['Add 2 AAA Batteries', 'Close and lock']]\nmdAcme.new_list(list1)\nlist2 = ['1. Set Level', ['1. Scroll to view levels', '2. Press Select'], '2. Press Start', ]\nmdAcme.new_list(list2) mdAcme.new_table_of_contents(table_title='Table of Contents', depth=3) mdAcme.create_md_file()<\/pre>\n
    Update, save and run the acme.py<\/code> file.<\/p>\n
    If we preview acme.md<\/code>, the following displays.<\/p>\n
    \n
    \"\"<\/figure>\n<\/div>\n
    \n
    Summary<\/h2>\n
    This article has shown you how to construct a fantastic-looking flat-text file!<\/p>\n
    Good Luck & Happy Coding!<\/p>\n
    \n
    Programmer Humor – Blockchain<\/h2>\n
    \n
    \"\"
    “Blockchains are like grappling hooks, in that it’s extremely cool when you encounter a problem for which they’re the right solution, but it happens way too rarely in real life.”<\/em> source <\/strong>– xkcd<\/a><\/figcaption><\/figure>\n<\/div>\n","protected":false},"excerpt":{"rendered":"
    5\/5 – (1 vote) This article will show you how to create and work with markdown files using Python. Markdown is an excellent tool with many features to spice up a flat-text file, such as changing text colors, adding bullet points, tables, and much more. A terrific way to add pizzazz to an otherwise dull […]<\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[857],"tags":[73,468,528],"class_list":["post-129504","post","type-post","status-publish","format-standard","hentry","category-python-tut","tag-programming","tag-python","tag-tutorial"],"_links":{"self":[{"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/posts\/129504","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/comments?post=129504"}],"version-history":[{"count":0,"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/posts\/129504\/revisions"}],"wp:attachment":[{"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/media?parent=129504"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/categories?post=129504"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/tags?post=129504"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}