phrazor


Namephrazor JSON
Version 0.0.3 PyPI version JSON
download
home_pagehttps://github.com/vphrase-pvt-ltd/phrazor-python/tree/master/
SummaryPhrazor is a Python library that converts your data into textual insights.
upload_time2023-10-06 06:00:40
maintainer
docs_urlNone
authorvPhrase Analytics Solutions Pvt. Ltd.
requires_python>=3.6
licenseGNU Affero General Public License
keywords insights
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ![Python versions](https://img.shields.io/badge/python>=-3.6-blue.svg)

## [Phrazor API Postman Workspace](https://www.postman.com/vphrase/workspace/phrazor-api)

### Phrazor Insights Collection 
For Postman Docs visit [Phrazor Postman Docs](https://documenter.getpostman.com/view/30152822/2s9YJc2ifY)

[![Run in Postman](https://run.pstmn.io/button.svg)](https://god.gw.postman.com/run-collection/30152822-cd724c00-a511-440c-95c0-90e5d3e0fa48?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D30152822-cd724c00-a511-440c-95c0-90e5d3e0fa48%26entityType%3Dcollection%26workspaceId%3D93db9691-c25b-488e-8647-b2977be3f65f)

# 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"))
```



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/vphrase-pvt-ltd/phrazor-python/tree/master/",
    "name": "phrazor",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "",
    "keywords": "insights",
    "author": "vPhrase Analytics Solutions Pvt. Ltd.",
    "author_email": "dev@vphrase.com",
    "download_url": "https://files.pythonhosted.org/packages/68/0b/926858dbf7e369010c6f9a416b56e650fc0f38907a29e2a7e08bdcbb0991/phrazor-0.0.3.tar.gz",
    "platform": null,
    "description": "![Python versions](https://img.shields.io/badge/python>=-3.6-blue.svg)\n\n## [Phrazor API Postman Workspace](https://www.postman.com/vphrase/workspace/phrazor-api)\n\n### Phrazor Insights Collection \nFor Postman Docs visit [Phrazor Postman Docs](https://documenter.getpostman.com/view/30152822/2s9YJc2ifY)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://god.gw.postman.com/run-collection/30152822-cd724c00-a511-440c-95c0-90e5d3e0fa48?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D30152822-cd724c00-a511-440c-95c0-90e5d3e0fa48%26entityType%3Dcollection%26workspaceId%3D93db9691-c25b-488e-8647-b2977be3f65f)\n\n# Phrazor Python Library\n\nPhrazor is a Python library that converts your data into textual insights.\n\nYou can find usage examples for the Phrazor Python library in our [Phrazor Docs](https://docs.phrazor.ai/)\n\n## Quick Start\n\nClick here to go to [Quick start of Phrazor SDK](https://docs.phrazor.ai/docs/quick-start)\n\n## Installation\n\nYou don't need this source code unless you want to modify the package. If you just\nwant to use the package, just run:\n\n```sh\npip install --upgrade phrazor\n```\n\nInstall from source with:\n\n```sh\npython setup.py install\n```\n\n## Usage\n\nThe library needs to be configured with your account's secret key which is available on\nthe [website](https://platform.phrazor.ai).\n\nOr set `phrazor.API_KEY` to its value:\n\n```python\nimport phrazor\n\nphrazor.API_KEY = \"YOUR API KEY\"\nphrzr = phrazor.Phrazor()\n\n# set data\nphrzr.set_data({\"Column Name 1\": [list of values], \"Column Name 2\": [list of values]})\n\n# set column meta\nphrzr.set_column_meta(\n    date_column=\"Date Column Name\", metric_column=[\"Metric Column Name 2\"],\n    dimension_column=\"Dimension Column Name\"\n)\n\n# supported analysis - (\"descriptor\", \"change\", \"compare_measure\", \"compare_dimension\", \"target_vs_achievement\", \"budget\" or \"trend\")\n# print the generated insights\nprint(phrzr.get_insights(\"descriptor\"))\n```\n\n\n",
    "bugtrack_url": null,
    "license": "GNU Affero General Public License",
    "summary": "Phrazor is a Python library that converts your data into textual insights.",
    "version": "0.0.3",
    "project_urls": {
        "Homepage": "https://github.com/vphrase-pvt-ltd/phrazor-python/tree/master/"
    },
    "split_keywords": [
        "insights"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "680b926858dbf7e369010c6f9a416b56e650fc0f38907a29e2a7e08bdcbb0991",
                "md5": "f1fd458918c8c6e1ed73fadcb0676297",
                "sha256": "f27a925b13ebab86bb03d958992521631285aa24801987918b42065a68b669aa"
            },
            "downloads": -1,
            "filename": "phrazor-0.0.3.tar.gz",
            "has_sig": false,
            "md5_digest": "f1fd458918c8c6e1ed73fadcb0676297",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 18602,
            "upload_time": "2023-10-06T06:00:40",
            "upload_time_iso_8601": "2023-10-06T06:00:40.115964Z",
            "url": "https://files.pythonhosted.org/packages/68/0b/926858dbf7e369010c6f9a416b56e650fc0f38907a29e2a7e08bdcbb0991/phrazor-0.0.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-10-06 06:00:40",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "vphrase-pvt-ltd",
    "github_project": "phrazor-python",
    "github_not_found": true,
    "lcname": "phrazor"
}
        
Elapsed time: 0.12133s