Metadata-Version: 2.1
Name: phrazor
Version: 0.0.2
Summary: Phrazor is a Python library that converts your data into textual insights.
Home-page: https://github.com/vphrase-pvt-ltd/phrazor-python/tree/master/
Author: vPhrase Analytics Solutions Pvt. Ltd.
Author-email: dev@vphrase.com
License: GNU Affero General Public License
Keywords: insights
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Classifier: Natural Language :: English
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
Requires-Python: >=3.6
Description-Content-Type: text/markdown

![Python versions](https://img.shields.io/badge/python>=-3.6-blue.svg)

# Phrazor Python Library

Phrazor is a Python library that converts your data into textual insights.

You can find usage examples for the Phrazor Python library in our [Phrazor Docs](https://docs.phrazor.ai/)

## Quick Start

Click here to go to [Quick start of Phrazor SDK](https://docs.phrazor.ai/docs/quick-start)

## Installation

You don't need this source code unless you want to modify the package. If you just
want to use the package, just run:

```sh
pip install --upgrade phrazor
```

Install from source with:

```sh
python setup.py install
```

## Usage

The library needs to be configured with your account's secret key which is available on
the [website](https://platform.phrazor.ai).

Or set `phrazor.API_KEY` to its value:

```python
import phrazor

phrazor.API_KEY = "YOUR API KEY"
phrzr = phrazor.Phrazor()

# set data
phrzr.set_data({"Column Name 1": [list of values], "Column Name 2": [list of values]})

# set column meta
phrzr.set_column_meta(
    date_column="Date Column Name", metric_column=["Metric Column Name 2"],
    dimension_column="Dimension Column Name"
)

# supported analysis - ("descriptor", "change", "compare_measure", "compare_dimension", "target_vs_achievement", "budget" or "trend")
# print the generated insights
print(phrzr.get_insights("descriptor"))
```
