Metadata-Version: 2.1
Name: mdprint
Version: 0.1.0
Summary: Python tools to print strings to markdown file with styles. Also allows printing dicts and lists to table
Home-page: https://github.com/saravanabalagi/mdprint
Author: Saravanabalagi Ramachandran
Author-email: saravanabalagi@hotmail.com
License: MIT
Description: # mdprint
        
        Python tools to print strings to markdown file with styles. Also allows printing dicts and lists to table
        
        ## Installation
        
        ```
        pip install mdprint
        ```
        ## Quick Start
        
        ### Basics
        
        ```
        mdprint('Markdown styles', heading=3)
        mdprint('It is convenient to use mdprint just like print.\n')
        mdprint('You can make text ', end='')
        mdprint('bold', bold=True, end=', ')
        mdprint('italics', italics=True, end=', ')
        mdprint('or even ', end='')
        mdprint('strikethrough', strikethrough=True, end='')
        ```
        
        ### Markdown styles
        It is convenient to use mdprint just like print.
        
        You can make text **bold**, _italics_, or even ~~strikethrough~~
        
        ### Writing to file
        
        mdprint takes `file` argument similar to `print`
        
        ```
        with open('README.md', 'w') as f:
            mdprint('Hello', heading=2, file=f)
        ```
        
        ### Dict
        ```
        from mdprint import mdprint_dict
        mydict = {'dogs': ['goldie', 'labrador', 'bulldog'], 'cats': ['polydactyl', 'snowshoe', 'calico'], 'fish': ['cod', 'herring', 'mackerel']}
        ```
        
        ```
        mdprint_dict(mydict)
        ```
        
        | dogs | cats | fish |
        |----|----|----|
        | goldie | polydactyl | cod |
        | labrador | snowshoe | herring |
        | bulldog | calico | mackerel |
        
        ### List
        
        ```
        from mdprint import mdprint_list
        mylist = [['goldie', 'labrador', 'bulldog'], [4, 5, 6], [7, 8, 9], [10, 11, 12]]
        ```
        
        ```
        mdprint_list(mylist)
        ```
        
        | goldie | labrador | bulldog |
        |----|----|----|
        | 4 | 5 | 6 |
        | 7 | 8 | 9 |
        | 10 | 11 | 12 |
        
        ### Advanced
        
        You can sort, invert and combine commands
        
        ```
        mdprint_list([['animal type', 'variety 1', 'variety 2', 'variety 3']], end='')
        mdprint_dict(b, keys_as_headers=False, sort_keys=True, start='')
        ```
        
        | animal type | variety 1 | variety 2 | variety 3 |
        |----|----|----|----|
        | *cats* | polydactyl | snowshoe | calico |
        | *dogs* | goldie | labrador | bulldog |
        | *fish* | cod | herring | mackerel |
        
        
        ## Contributing
        
        Pull requests are very welcome.
        
        1. Fork the repo
        1. Create new branch with feature name as branch name
        1. Check if things work with a jupyter notebook
        1. Raise a pull request
        
        ## Licence
        
        Please see attached [Licence](LICENCE)
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Topic :: Software Development :: Libraries
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
