Metadata-Version: 2.1
Name: pynarrator
Version: 0.0.1.5
Summary: Template-based NLG framework for creating text narratives out of data
Home-page: UNKNOWN
Author: Denis Abdullin
Author-email: denisabdullincz@gmail.com
License: UNKNOWN
Keywords: python,nlg,template,chatgpt
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
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: Operating System :: OS Independent
Description-Content-Type: text/markdown
Provides-Extra: dev
License-File: LICENSE

# pynarrator
Template-based NLG framework for creating text narratives out of data

## Installation

You can install the package from pip:

```bash
pip3 install pynarrator
```

## Usage

Import the package functions and create a data frame.

```python
from pynarrator import narrate_descriptive, read_data

df = read_data()

df.head()
```

Now create descriptive narratives from your data
```python
narrate_descriptive(df, measure = 'Sales', dimensions = ['Region', 'Product'])
```


