mdutils

Name	mdutils JSON
Version	1.6.0 JSON
	download
home_page	https://github.com/didix21/mdutils
Summary	Useful package for creating Markdown files while executing python code.
upload_time	2023-04-29 14:39:34
maintainer	Didac Coll
docs_url	None
author	Didac Coll
requires_python
license	MIT
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage

            =======
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...
- Align text.
- 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 Lists.
- 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
============

Pip
---
Use pip to install mdutils:

.. code:: bash

    $ pip install mdutils

Poetry
------
Use poetry to install mdutils:

.. code:: bash

    $ poetry add mdutils


.. |build-status| image:: https://github.com/didix21/mdutils/actions/workflows/main.yml/badge.svg
    :target: https://github.com/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://codecov.io/gh/didix21/mdutils/branch/master/graph/badge.svg?token=0DN72Z1B6V
    :target: https://codecov.io/gh/didix21/mdutils
    :alt: Coverage Status

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/didix21/mdutils",
    "name": "mdutils",
    "maintainer": "Didac Coll",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "didaccoll_93@hotmail.com",
    "keywords": "",
    "author": "Didac Coll",
    "author_email": "didaccoll_93@hotmail.com",
    "download_url": "https://files.pythonhosted.org/packages/b1/ec/6240f147530a2c8d362ed3f2f7985aca92cda68c25ffc2fc216504b17148/mdutils-1.6.0.tar.gz",
    "platform": "Python 3.6",
    "description": "=======\nmdutils\n=======\n|build-status| |documentation-status| |coverage-status|\n\n.. contents:: Table of Contents\n\nOverview\n========\nThis Python package contains a set of basic tools that can help to create a markdown file while running a Python code.\nThus, if you are executing a Python code and you save the result in a text file, Why not format it? So\nusing files such as Markdown can give a great look to those results. In this way, mdutils will make things easy for\ncreating Markdown files.\n\n- Project Homepage: https://github.com/didix21/mdutils\n- Download Page: https://pypi.python.org/pypi/mdutils\n- Documentation: http://mdutils.readthedocs.io/en/latest/\n\nMIT License, (C) 2018 Didac Coll <didaccoll_93@hotmail.com>\n\nFeatures\n========\nThere are some different features available on that version of mdutils:\n\nWriting and Reading Files\n-------------------------\n- Write and Read Markdown files.\n- Append data to the end of a Markdown file.\n- Use markers to place text.\n\nMarkdown\n--------\n- Implemented method to give format to the text: bold, italics, change color...\n- Align text.\n- Add headers of levels 1 til 6 (atx style) or 1 and 2 (setext style).\n- Create tables.\n- Create a table of contents.\n- Add Links.\n- Add Lists.\n- Add Markdown Images.\n- Add Html Images.\n\n.. note::\n\n    Some available features will depen on which CSS you are using. For example, GitHub do not allows to give color to text.\n\n\nInstallation\n============\n\nPip\n---\nUse pip to install mdutils:\n\n.. code:: bash\n\n    $ pip install mdutils\n\nPoetry\n------\nUse poetry to install mdutils:\n\n.. code:: bash\n\n    $ poetry add mdutils\n\n\n.. |build-status| image:: https://github.com/didix21/mdutils/actions/workflows/main.yml/badge.svg\n    :target: https://github.com/didix21/mdutils\n    :alt: Build Status\n\n.. |documentation-status| image:: https://readthedocs.org/projects/mdutils/badge/?version=latest\n    :target: http://mdutils.readthedocs.io/en/latest/?badge=latest\n    :alt: Documentation Status\n\n.. |coverage-status| image:: https://codecov.io/gh/didix21/mdutils/branch/master/graph/badge.svg?token=0DN72Z1B6V\n    :target: https://codecov.io/gh/didix21/mdutils\n    :alt: Coverage Status\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Useful package for creating Markdown files while executing python code.",
    "version": "1.6.0",
    "project_urls": {
        "Documentation": "http://mdutils.readthedocs.io",
        "Homepage": "https://github.com/didix21/mdutils",
        "Say Thanks!": "https://github.com/didix21/",
        "Source": "https://github.com/didix21/mdutils"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b1ec6240f147530a2c8d362ed3f2f7985aca92cda68c25ffc2fc216504b17148",
                "md5": "e36b6fdff56c95ff4a7bb236a7d59125",
                "sha256": "647f3cf00df39fee6c57fa6738dc1160fce1788276b5530c87d43a70cdefdaf1"
            },
            "downloads": -1,
            "filename": "mdutils-1.6.0.tar.gz",
            "has_sig": false,
            "md5_digest": "e36b6fdff56c95ff4a7bb236a7d59125",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 22881,
            "upload_time": "2023-04-29T14:39:34",
            "upload_time_iso_8601": "2023-04-29T14:39:34.994954Z",
            "url": "https://files.pythonhosted.org/packages/b1/ec/6240f147530a2c8d362ed3f2f7985aca92cda68c25ffc2fc216504b17148/mdutils-1.6.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-04-29 14:39:34",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "didix21",
    "github_project": "mdutils",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "lcname": "mdutils"
}

Didac Coll