Metadata-Version: 1.2
Name: mdutils
Version: 1.1.1
Summary: Useful package for creating Markdown files while executing python code.
Home-page: https://github.com/didix21/mdutils
Author: Didac Coll
Author-email: didaccoll_93@hotmail.com
Maintainer: Didac Coll
Maintainer-email: didaccoll_93@hotmail.com
License: MIT
Project-URL: Documentation, http://mdutils.readthedocs.io
Project-URL: Say Thanks!, https://github.com/didix21/
Project-URL: Source, https://github.com/didix21/mdutils
Description: =======
        mdutils
        =======
        |build-status| |documentation-status| |coverage-status|
        
        .. contents:: Table of Contents
        
        Overview
        ========
        This Python package contains a set of basic tools that can help to create a markdown file while running a Python code.
        Thus, if you are executing a Python code and you save the result in a text file, Why not format it? So
        using files such as Markdown can give a great look to those results. In this way, mdutils will make things easy for
        creating Markdown files.
        
        - Project Homepage: https://github.com/didix21/mdutils
        - Download Page: https://pypi.python.org/pypi/mdutils
        - Documentation: http://mdutils.readthedocs.io/en/latest/
        
        MIT License, (C) 2018 Didac Coll <didaccoll_93@hotmail.com>
        
        Features
        ========
        There are some different features available on that version of mdutils:
        
        Writing and Reading Files
        -------------------------
        - Write and Read Markdown files.
        - Append data to the end of a Markdown file.
        - Use markers to place text.
        
        Markdown
        --------
        - Implemented method to give format to the text: bold, italics, change color...
        - Add headers of levels 1 til 6 (atx style) or 1 and 2 (setext style).
        - Create tables.
        - Create a table of contents.
        - Add Links.
        - Add Markdown Images.
        - Add Html Images.
        
        .. note::
        
            Some available features will depen on which CSS you are using. For example, GitHub do not allows to give color to text.
        
        
        Installation
        ============
        Use pip to install mdutils:
        
        .. code:: bash
        
            $ pip install mdutils
        
        
        
        .. |build-status| image:: https://travis-ci.org/didix21/mdutils.svg?branch=master
            :target: https://travis-ci.org/didix21/mdutils
            :alt: Build Status
        
        .. |documentation-status| image:: https://readthedocs.org/projects/mdutils/badge/?version=latest
            :target: http://mdutils.readthedocs.io/en/latest/?badge=latest
            :alt: Documentation Status
        
        .. |coverage-status| image:: https://coveralls.io/repos/github/didix21/mdutils/badge.svg?branch=add-coveralls
            :target: https://coveralls.io/github/didix21/mdutils?branch=add-coveralls
            :alt: Coverage Status
        
Platform: Python 3.6
Platform: Python 3.7
Platform: Python 3.8
Classifier: Development Status :: 5 - Production/Stable
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Utilities
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Text Processing :: Markup
Classifier: License :: OSI Approved :: MIT License
