Metadata-Version: 2.1
Name: readmint
Version: 0.0.1
Project-URL: Documentation, https://github.com/unknown/readmint#readme
Project-URL: Issues, https://github.com/unknown/readmint/issues
Project-URL: Source, https://github.com/unknown/readmint
Author-email: Alvaro Leiva Geisse <aleivag@gmail.com>
License: MIT License
        
        Copyright (c) 2023-present Alvaro Leiva Geisse <aleivag@gmail.com>
        
        Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
License-File: LICENSE.md
License-File: LICENSE.txt
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.7
Requires-Dist: click
Requires-Dist: ipython
Requires-Dist: marko
Description-Content-Type: text/markdown

# readmint

[![PyPI - Version](https://img.shields.io/pypi/v/readmint.svg)](https://pypi.org/project/readmint)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/readmint.svg)](https://pypi.org/project/readmint)

* * *

A simple, yet effective way of adding some dynamic properties to you md. 

**Table of Contents**

- [Installation](#installation)
- [License](#license)

## Installation

```console
pip install readmint
```

## Using it (shell)

## Using it (api)

```python
# import the render function

In [1]: from readmint.lib.renderer import render_text, render_file
        import textwrap

        print("hello world")
```

```python
# render text just rendera passed text
In [2]: render_text(
            textwrap.dedent("""
                dummy text
                ==========
        
                And this is a code block
        
                ```readmint[python@local]
                1+1
                ```
            """)
        )

Out[2]: 
# dummy text

And this is a code block

```python

In [1]: 1+1

Out[1]: 2
```
```

## License

`readmint` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
