Development

.gitignore

@@ -6,6 +6,10 @@ __pycache__/
 # C extensions
 *.so
 
+# Others
+Test.md
+.idea*
+
 # Distribution / packaging
 .Python
 build/

MANIFEST.in

@@ -0,0 +1 @@
+include README.md

README.md

@@ -0,0 +1,18 @@
+# mdutils
+This package contains all of this utils necessary to create a Markdown file while you are executing python code. This
+ package it is useful when you are interested in save data on file and give format to it at the same time.
+
+ ## Featerues
+
+- Create a Markdown file.
+- Create headers (1, 2, 3 til... 6).
+- Create automatic table of contents.
+- Give format to text: **bold**, _italics_ , `inline code`, <font color='orange'> change text color </font>...
+- Insert internal links `[Text to be displayed](#text-to-be-displayed)` or external links `[external link]
+(https://external.link.es)`
+- Create tables
+
+## Thinks to do
+
+- Insert images, align them...
+

Test/test_mdUtils.py

@@ -0,0 +1,18 @@
+from unittest import TestCase
+
+
+class TestMdUtils(TestCase):
+    def test_create_md_file(self):
+        self.fail()
+
+    def test_new_header(self):
+        self.fail()
+
+    def test__add_new_item_table_of_content(self):
+        self.fail()
+
+    def test_new_table_of_contents(self):
+        self.fail()
+
+    def test_create_table(self):
+        self.fail()

Test/test_tools/test_header.py

@@ -0,0 +1,62 @@
+from unittest import TestCase
+from mdutils.tools.tools import Header
+
+__author__ = 'didix21'
+__project__ = 'MdUtils'
+
+class TestHeader(TestCase):
+
+    def test_atx_level_1(self):
+        title = "Text Title Atx 1"
+        result = '\n# ' + title + '\n'
+        self.assertEqual(Header().atx_level_1(title), result)
+
+    def test_atx_level_2(self):
+        title = "Text Title Atx 2"
+        result = '\n## ' + title + '\n'
+        self.assertEqual(Header().atx_level_2(title), result)
+
+    def test_atx_level_3(self):
+        title = "Text Title Atx 3"
+        result = '\n### ' + title + '\n'
+        self.assertEqual(Header().atx_level_3(title), result)
+
+    def test_atx_level_4(self):
+        title = "Text Title Atx 4"
+        result = '\n#### ' + title + '\n'
+        self.assertEqual(Header().atx_level_4(title), result)
+
+    def test_atx_level_5(self):
+        title = "Text Title Atx 5"
+        result = '\n##### ' + title + '\n'
+        self.assertEqual(Header().atx_level_5(title), result)
+
+    def test_atx_level_6(self):
+        title = "Text Title Atx 6"
+        result = '\n###### ' + title + '\n'
+        self.assertEqual(Header().atx_level_6(title), result)
+
+    def test_setext_level_1(self):
+        title = "Text Title Setext 1"
+        result = '\n' + title + '\n' + ''.join(['=' for _ in title]) + '\n'
+        self.assertEqual(Header().setext_level_1(title), result)
+
+    def test_setext_level_2(self):
+        title = "Text Title Setext 2"
+        result = '\n' + title + '\n' + ''.join(['-' for _ in title]) + '\n'
+        self.assertEqual(Header().setext_level_2(title), result)
+
+    def test_choose_header(self):
+        header = Header()
+        func_list = [header.atx_level_1('Atx Example'), header.atx_level_2('Atx Example'),
+                     header.atx_level_3('Atx Example'), header.atx_level_4('Atx Example'),
+                     header.atx_level_5('Atx Example'), header.atx_level_6('Atx Example'),
+                     header.setext_level_1('Setext Example'), header.setext_level_2('Setext Example')]
+        for x in range(8):
+            if x < 6:
+                title = 'Atx Example'
+                chosen_header = header.choose_header(level=x + 1, title=title, style='atx')
+            else:
+                title = 'Setext Example'
+                chosen_header = header.choose_header(level=x - 5, title=title, style='setext')
+            self.assertEqual(chosen_header, func_list[x])

Test/test_tools/test_table.py

@@ -0,0 +1,61 @@
+from unittest import TestCase
+from mdutils.tools.tools import Table
+from mdutils.mdutils import MdUtils
+
+__author__ = 'didix21'
+__project__ = 'MdUtils'
+
+class TestTable(TestCase):
+    def test_create_table(self):
+        md_file = MdUtils("file_name")
+        table = Table()
+        result_table = '\n|**Test**|**Descripción**|**Estado**|\n| :---: | :---: | :---: ' \
+                       '|\n|Test 1|Carga de configuración correcta|<font color="green"> OK </font>|\n' \
+                       '|Test 2|Lectura de Configuración|<font color="red"> NOK </font>|\n' \
+                       '|Test 3|Lectura de Soporte|<font color="green"> OK </font>|\n' \
+                       '|Test 4|Modificación de entradas y lectura de salidas de cantón|<font color="green"> ' \
+                       'OK </font>|'\
+                       '\n|Test 5|Lectura de estados de Pedal de Rearme y Aviso|<font color="green"> OK </font>|\n' \
+                       '|Test 6|Actualización de datos de unidades de vía|<font color="green"> OK </font>|\n' \
+                       '|Test 7|Fallos en carga de configuración - Campo IdApp Erróneo|<font color="green"> ' \
+                       'OK </font>|' \
+                       '\n' \
+                       '|Test 8|Fallos en carga de configuración - Campo VersTAbla Erróneo' \
+                       '|<font color="red"> NOK </font>|'\
+                       '\n|Test 9|Fallos en carga de configuración - Campo IdUc Erróneo|<font color="red"> ' \
+                       'NOK </font>|' \
+                       '\n|Test 10|Fallos en carga de configuración - Campo Addresses Erróneo' \
+                       '|<font color="red"> NOK </font>|\n' \
+                       '|Test 11|Fallos en carga de configuración - Campo NumTc Erróneo' \
+                       '|<font color="red"> NOK </font>|\n' \
+                       '|Test 12|Fallos en carga de configuración - Campo NumUv Erróneo' \
+                       '|<font color="red"> NOK </font>|\n' \
+                       '|Test 13|Fallos en carga de configuración - Campo CRC Erróneo|<font color="red"> NOK </font>|\n'
+
+        text_array = ['**Test**', '**Descripción**', '**Estado**',
+                      'Test 1', 'Carga de configuración correcta', md_file.textUtils.text_color("OK", 'green'),
+                      'Test 2', 'Lectura de Configuración', md_file.textUtils.text_color("NOK", 'red'),
+                      'Test 3', 'Lectura de Soporte', md_file.textUtils.text_color("OK", 'green'),
+                      'Test 4', 'Modificación de entradas y lectura de salidas de cantón',
+                      md_file.textUtils.text_color("OK", 'green'),
+                      'Test 5', 'Lectura de estados de Pedal de Rearme y Aviso',
+                      md_file.textUtils.text_color("OK", 'green'),
+                      'Test 6', 'Actualización de datos de unidades de vía',
+                      md_file.textUtils.text_color("OK", 'green'),
+                      'Test 7', 'Fallos en carga de configuración - Campo IdApp Erróneo',
+                      md_file.textUtils.text_color("OK", 'green'),
+                      'Test 8', 'Fallos en carga de configuración - Campo VersTAbla Erróneo',
+                      md_file.textUtils.text_color("NOK", 'red'),
+                      'Test 9', 'Fallos en carga de configuración - Campo IdUc Erróneo',
+                      md_file.textUtils.text_color("NOK", 'red'),
+                      'Test 10', 'Fallos en carga de configuración - Campo Addresses Erróneo',
+                      md_file.textUtils.text_color("NOK", 'red'),
+                      'Test 11', 'Fallos en carga de configuración - Campo NumTc Erróneo',
+                      md_file.textUtils.text_color("NOK", 'red'),
+                      'Test 12', 'Fallos en carga de configuración - Campo NumUv Erróneo',
+                      md_file.textUtils.text_color("NOK", 'red'),
+                      'Test 13', 'Fallos en carga de configuración - Campo CRC Erróneo',
+                      md_file.textUtils.text_color("NOK", 'red')]
+
+        self.assertEqual(table.create_table(columns=3, rows=13, text=text_array), result_table)
+

Test/test_tools/test_tableOfContents.py

@@ -0,0 +1,20 @@
+from unittest import TestCase
+from mdutils.tools.tools import TableOfContents
+
+__author__ = 'didix21'
+__project__ = 'MdUtils'
+
+class TestTableOfContents(TestCase):
+
+    def test_create_table_of_contents(self):
+        array_of_contents = ['Results Tests', [], 'Test Details', ['Test 1', [], 'Test 2', [],
+                                                                   'Test 3', [], 'Test 4', []]]
+        result = '\n* [Results Tests](#results-tests)\n' \
+                 '* [Test Details](#test-details)\n\t' \
+                 '* [Test 1](#test-1)\n\t' \
+                 '* [Test 2](#test-2)\n\t' \
+                 '* [Test 3](#test-3)\n\t' \
+                 '* [Test 4](#test-4)\n'
+
+        table_of_contents = TableOfContents()
+        self.assertEqual(table_of_contents.create_table_of_contents(array_of_contents, depth=2), result)

Test/test_tools/test_textUtils.py

@@ -0,0 +1,47 @@
+from unittest import TestCase
+from mdutils.tools.tools import TextUtils
+
+__author__ = 'didix21'
+__project__ = 'MdUtils'
+
+class TestTextUtils(TestCase):
+    def test_bold(self):
+        expects = '**Bold Example**'
+        self.assertEqual(TextUtils().bold('Bold Example'), expects)
+
+    def test_italics(self):
+        expects = '_Italics Example_'
+        self.assertEqual(TextUtils().italics('Italics Example'), expects)
+
+    def test_inline_code(self):
+        expects = '`Inline Code Example`'
+        self.assertEqual(TextUtils().inline_code('Inline Code Example'), expects)
+
+    def test_center_text(self):
+        expects = '<center>Text Center Alignment Example</center>'
+        self.assertEqual(TextUtils().center_text('Text Center Alignment Example'), expects)
+
+    def test_text_color(self):
+        expects = '<font color="red"> Red Color Example </font>'
+        self.assertEqual(TextUtils().text_color('Red Color Example', 'red'), expects)
+
+    def test_text_external_link(self):
+        text = 'Text Example'
+        link = 'https://link.example.org'
+        expects = '[' + text + '](' + link + ')'
+        self.assertEqual(TextUtils().text_external_link(text, link), expects)
+
+    def test_text_format(self):
+        color = 'red'
+        text = 'Text Format'
+        text_color = TextUtils().text_color(text, color)
+        text_color_center = TextUtils().center_text(text_color)
+        text_color_center_b = TextUtils().bold(text_color_center)
+        text_color_center_bc = TextUtils().inline_code(text_color_center_b)
+        text_color_center_bci = TextUtils().italics(text_color_center_bc)
+
+        expects = text_color_center_bci
+        obtains = TextUtils().text_format(text, bold_italics_code='bci', color='red', align='center')
+
+        self.assertEqual(obtains, expects)
+

Testing_md.py

@@ -0,0 +1,10 @@
+from mdutils.mdutils import MdUtils
+
+md_file = MdUtils("Testing_md", title="Testing Tables")
+text_array = ["Test", "Description", "State", "Test 1", "Carga de configuración correcta", "OK"]
+
+md_file.create_md_file()
+md_file.markdown_file.append_end('\n\n')
+md_file.create_table(3, 3, text_array)
+
+

mdutils/__init__.py

@@ -0,0 +1,3 @@
+from mdutils.mdutils import MdUtils
+from mdutils.fileutils import fileutils
+from mdutils.tools import tools

mdutils/fileutils/__init__.py

@@ -0,0 +1 @@
+from mdutils.fileutils.fileutils import MarkDownFile

mdutils/fileutils/fileutils.py

@@ -0,0 +1,74 @@
+# Python
+#
+# This module implements a main class that allows to create markdown files, write in them or read.
+#
+# This file is part of mdutils. https://github.com/didix21/mdutils
+#
+# (C) 2018 Dídac Coll
+#
+# SPDX-License-Identifier:   BSD-3-Clause
+
+
+class MarkDownFile(object):
+    """MarkDownFile class creates a new file of MarkDown extension.
+
+    Features available are:
+    - Create a file.
+    - Rewrite all the file with new data.
+    - Write at the end of the file."""
+
+    def __init__(self, name=''):
+        """Creates a markdown file if name is not empty."""
+        if name:
+            self.file_name = name + '.md'
+            self.file = open(self.file_name, 'w+', encoding='UTF-8')
+            self.file.close()
+
+    def rewrite_all_file(self, data):
+        """Rewrite all the data of a Markdown file by ``data``.
+
+        :param data: is a string containing all the data that is written in the markdown file."""
+        with open(self.file_name, 'w', encoding='utf-8') as self.file:
+            self.file.write(data)
+
+    def append_end(self, data):
+        """Write at the last position of a Markdown file.
+
+        :param data: is a string containing all the data that is written in the markdown file."""
+        with open(self.file_name, 'a', encoding='utf-8') as self.file:
+            self.file.write(data)
+
+    def append_after_second_line(self, data):
+        """Write after the file's first line.
+
+        :param data: is a string containing all the data that is written in the markdown file."""
+        with open(self.file_name, 'r+', encoding='utf-8') as self.file:
+            file_data = self.file.read()                        # Save all the file's content
+            self.file.seek(0, 0)                                # Place file pointer at the beginning
+            first_line = self.file.readline()                   # Read the first line
+            second_line = self.file.readline()                  # Read the second line
+            self.file.seek(len(first_line + second_line), 0)    # Place file pointer at the end of the first line
+            self.file.write(data)                               # Write data
+            self.file.write('\n' + file_data[len(first_line + second_line):])
+
+    @staticmethod
+    def read_file(file_name):
+        """Read a Markdown file using a file name. Not necessary to put *.md extension.
+
+        :param file_name: Markdown file's name.
+        :type file_name: str
+        :return: return all file's data.
+        :rtype: str"""
+
+        if file_name.find('.md') == -1:
+            file_name += '.md'
+
+        with open(file_name, 'r', encoding='utf-8') as file:
+            file_data = file.read()
+
+        return file_data
+
+
+if __name__ == '__main__':
+    new_file = MarkDownFile('Example')
+    new_file.rewrite_all_file(data="# Some Text Example")