Metadata-Version: 1.1
Name: filter-pandoc-run-py
Version: 0.3
Summary: UNKNOWN
Home-page: https://github.com/caiofcm/filter_pandoc_run_py
Author: Caio Marcellos
Author-email: caiocuritiba@gmail.com
License: MIT
Download-URL: https://github.com/caiofcm/filter_pandoc_run_py/archive/0.1.tar.gz
Description-Content-Type: UNKNOWN
Description: # filter_pandoc_run_py 
        
        [![Build Status](https://img.shields.io/travis/caiofcm/filter_pandoc_run_py/master.svg)](https://travis-ci.org/caiofcm/filter_pandoc_run_py/branches)
        [![Coverage Status](https://coveralls.io/repos/github/caiofcm/filter_pandoc_run_py/badge.svg?branch=master)](https://coveralls.io/github/caiofcm/filter_pandoc_run_py?branch=master)
        [![PyPI version](https://img.shields.io/pypi/v/filter_pandoc_run_py.svg)](https://pypi.org/project/filter_pandoc_run_py/)
        [![PyPI format](https://img.shields.io/pypi/format/filter_pandoc_run_py.svg)](https://pypi.org/project/filter_pandoc_run_py/)
        [![License](https://img.shields.io/pypi/l/filter_pandoc_run_py.svg)](https://raw.githubusercontent.com/caiofcm/filter_pandoc_run_py/master/LICENSE)
        [![Python version](https://img.shields.io/pypi/pyversions/filter_pandoc_run_py.svg)](https://pypi.org/project/filter_pandoc_run_py/)
        [![Development Status](https://img.shields.io/pypi/status/filter_pandoc_run_py.svg)](https://pypi.org/project/filter_pandoc_run_py/)
        
        *filter_pandoc_run_py* is a [pandoc] filter for execute python codes written in `CodeBlocks` or inline `Code`. It receives the print statement output and place it to the markdown converted file. Also, it save any created pyplot figure to a folder and include it as a Image. Code has to be **trusted**
        
        [pandoc]: http://pandoc.org/
        
        <!-- https://github.com/chdemko/pandoc-latex-fontsize as reference -->
        
        ## Usage
        
        To apply the filter, use the following option with pandoc:
        
        	pandoc INFILE -F filter_pandoc_run_py --to FORMAT -o OUTFILE
        
        Example:
        
        	pandoc ./tests/test.md -t markdown filter_pandoc -o test_converted.md
        
        Tested only from markdown to markdown / html
        
        ## Installation
        
        *filter_pandoc_run_py* requires [python] (tested in version > 3.0)
        
        Install *filter_pandoc_run_py* as root using the bash command
        
        	git clone URL
        	cd dir
        	pip install .
        
        Or get it from PYPI:
        
        	pip install filter_pandoc_run_py
        
        
        ## How to Use It
        
        Create a regular markdown code but appending a class .run to it.
        
        ### For `CodeBlock`
        
        Syntax: `{.python .run format=[blockquote (default), text] hide_code=[False (default), True] }`
        
        "Pretty print" enable: output of print statement is converted and is rendered
        
        ### For `Code`
        
        The syntax is \`(print(code))\`\{.run\}
        
        "Pretty print" unable: output is the raw print statement output string
        
        ## Example
        
        From a markdown file such as:
        
        ```
        ```{.python .run}
        d = 1e3
        m = 2 * d
        print('The total mass is {:.2f} $m^3$'.format(m))
        \```
        ```
        
        `pandoc FILE --to markdown -F filter_pandoc_run_py.py -o OUTFILE.md`
        
        ```{.markdown}
        > Output:
        >
        > > The total mass is 2000.00 $m^3$
        ```
        
        It is also possible to use the syntax:
        
        ```
        ```python
        # filter: { .run .class key1=val key2="val 2"}
        code ..
        ```
        ```
        
        ## Getting Help
        
        If you have any difficulties with *filter_pandoc_run_py*, please feel welcome to [file an issue] on github so that we can help.
        
        [file an issue]: https://github.com/caiofcm/filter_pandoc_run_py/issues
        
        
        
        
        
Keywords: pandoc filters markdown python notes
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Topic :: Utilities
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Text Processing :: Filters
