## Introduction
An example of how to use the ClearInsights package within your python applications
- [Explore the docs](https://docs.clearinsights.io)
- [Request Feature](https://clearinsights.io/contact-us/)
## Getting Started
### Prerequisites
_Install the ClearInsights Package_
* Package Manager
```pip
pip install ClearInsights
```
### Installation
_Create a free ClearInsights account to start using the python package_
1. Get a free account at [https://clearinsights.io](https://clearinsights.io) and retrieve your API Key under the Administration ->APIKey menu.
2. Create at least 1 product and 1 environment and retrieve the Client Secret for the product/environment.
3. Import ClearInsights
```
import ClearInsights
```
4. Initialize and use ClearInsights Logger class
```py
log = ClearInsights.Logger(apiKey = "{ApiKey}", clientSecret = "{ClientSecret}", applicationName = "{ApplicationName, Ex. My First App}")
log.LogInformation("App started");
```
5. Use global exception handling.
```py
def my_except_hook(exctype, error, error_traceback):
log = ClearInsights.Logger(apiKey = "{ApiKey}", clientSecret = "{ClientSecret}", applicationName = "{ApplicationName, Ex. My First App}")
log.LogError(error)
def main():
sys.excepthook = my_except_hook
```
## Usage
Use this app as an example of how to use the ClearInsights package within your python applications.
_For more examples, please refer to the [Documentation](https://docs.clearinsights.io)_
Raw data
{
"_id": null,
"home_page": "https://clearinsights.io",
"name": "ClearInsights",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "logging,monitoring,insights,application insights,clearinsights",
"author": "ClearInsights",
"author_email": "support@clearinsights.io",
"download_url": "",
"platform": null,
"description": "## Introduction \nAn example of how to use the ClearInsights package within your python applications\n- [Explore the docs](https://docs.clearinsights.io)\n- [Request Feature](https://clearinsights.io/contact-us/)\n\n\n## Getting Started\n\n\n\n### Prerequisites\n\n_Install the ClearInsights Package_\n* Package Manager\n ```pip\n pip install ClearInsights\n ```\n\n\n### Installation\n\n_Create a free ClearInsights account to start using the python package_\n\n1. Get a free account at [https://clearinsights.io](https://clearinsights.io) and retrieve your API Key under the Administration ->APIKey menu.\n2. Create at least 1 product and 1 environment and retrieve the Client Secret for the product/environment.\n3. Import ClearInsights \n ```\n import ClearInsights\n ```\n4. Initialize and use ClearInsights Logger class\n ```py\n log = ClearInsights.Logger(apiKey = \"{ApiKey}\", clientSecret = \"{ClientSecret}\", applicationName = \"{ApplicationName, Ex. My First App}\")\n log.LogInformation(\"App started\");\n ```\n5. Use global exception handling.\n ```py\n def my_except_hook(exctype, error, error_traceback): \n log = ClearInsights.Logger(apiKey = \"{ApiKey}\", clientSecret = \"{ClientSecret}\", applicationName = \"{ApplicationName, Ex. My First App}\")\n log.LogError(error)\n\n def main(): \n sys.excepthook = my_except_hook\n ```\n\n\n## Usage\n\nUse this app as an example of how to use the ClearInsights package within your python applications.\n\n_For more examples, please refer to the [Documentation](https://docs.clearinsights.io)_\n\n\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "A portable class Library for the ClearInsights API. (Official Library)",
"version": "0.1.9",
"project_urls": {
"Bug Reports": "https://clearinsights.io/contact-us/",
"Documentation": "https://docs.clearinsights.io",
"Homepage": "https://clearinsights.io"
},
"split_keywords": [
"logging",
"monitoring",
"insights",
"application insights",
"clearinsights"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "367099e09da9dc83a3a0741859e5e498ba2bd57d111d9b424699c05f81660ccd",
"md5": "853a7ef944a878a1eab6d7d591b20ac0",
"sha256": "2a5e1f7b1687165948c977053d2b12c11c882e671fb0efbedefd66eab5929887"
},
"downloads": -1,
"filename": "ClearInsights-0.1.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "853a7ef944a878a1eab6d7d591b20ac0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 4065,
"upload_time": "2023-06-28T16:39:03",
"upload_time_iso_8601": "2023-06-28T16:39:03.478578Z",
"url": "https://files.pythonhosted.org/packages/36/70/99e09da9dc83a3a0741859e5e498ba2bd57d111d9b424699c05f81660ccd/ClearInsights-0.1.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-28 16:39:03",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "clearinsights"
}
JSON