# NORTH GRAVITY PYTHON UTILS #
This document describes the North Gravity Python Utils package which enables users to use the NG platform tools and most common functions within their python scripts / tasks repositories.
The Python Utils can be used within:
- a single python script that is ran thanks to the Python Runner task within a pipeline in the NG application
- a single Jupyter Notebook that is ran thanks to the Jupyter Runner task within a pipeline in the NG application
- an ensemble of python scripts that are part of a container, for a Task created by the user, used in a pipeline in the NG application
NG_Utils cover most frequently used functions for data/files handling purposes.
The scope of the NG_Utils:
- **DataHandler** - splitting data based on train/test labels, handling dates in datasets
- **FileHandler** - downloading/uploading model-specific datasets from/to the data lake, handling datasets formats
- **BackTest** - preparing short or extended backtest based on models results
- **StatTest** - preparing report and running statistical tests for stationarity, autocorrelation and volatitity clustering
-**TaskExecUtils** - auxiliary functions used in executing tasks
## How to install and set the package:
### Install
```text
pip3 install northgravity_utils==0.1.0
```
As the library is available from pip, it can be installed as a specific version within a Python Task from within requirements.txt just by adding:
```text
northgravity_utils==0.1.0
```
The package relies on the requests library so, in the project, the user must install this library in the requirements.txt file.
```text
pip3 install requests==2.27.1
```
### Environment Variables
The package uses information from the environment variables. They are necessery for functionality of Nortygravity SDK package, used in Northgravity Utils
Environment variables are automatically provided when running a script within a pipeline (as a Task or within the Python/Jupyter Runners).
If running locally the script, users must set them in the project to be able to run the project locally.
Mandatory environment variables to set:
- LOGIN → login received from NG
- PASSWORD → password to log in. Credentials are used to generate the token so that each request is authenticated.
- NG_API_ENDPOINT → the URL to the NG platform API (by default, the url is set to https://api.northgravity.com)
Raw data
{
"_id": null,
"home_page": "https://www.northgravity.com/",
"name": "northgravity-utils",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "northgravity, utils",
"author": "NorthGravity",
"author_email": "info@northgravity.com",
"download_url": "https://files.pythonhosted.org/packages/11/7e/eca05ff3150e7af8a51f9f582fae39085591f6315d9534d86a28b164192f/northgravity_utils-0.1.0.tar.gz",
"platform": null,
"description": "# NORTH GRAVITY PYTHON UTILS #\n\nThis document describes the North Gravity Python Utils package which enables users to use the NG platform tools and most common functions within their python scripts / tasks repositories. \n\nThe Python Utils can be used within:\n\n- a single python script that is ran thanks to the Python Runner task within a pipeline in the NG application\n\n- a single Jupyter Notebook that is ran thanks to the Jupyter Runner task within a pipeline in the NG application\n\n- an ensemble of python scripts that are part of a container, for a Task created by the user, used in a pipeline in the NG application\n\n \n\nNG_Utils cover most frequently used functions for data/files handling purposes.\n\nThe scope of the NG_Utils:\n\n- **DataHandler** - splitting data based on train/test labels, handling dates in datasets \n\n- **FileHandler** - downloading/uploading model-specific datasets from/to the data lake, handling datasets formats\n\n- **BackTest** - preparing short or extended backtest based on models results\n\n- **StatTest** - preparing report and running statistical tests for stationarity, autocorrelation and volatitity clustering\n\n-**TaskExecUtils** - auxiliary functions used in executing tasks \n\n\n\n\n## How to install and set the package: \n### Install\n```text\npip3 install northgravity_utils==0.1.0\n```\nAs the library is available from pip, it can be installed as a specific version within a Python Task from within requirements.txt just by adding:\n```text\nnorthgravity_utils==0.1.0\n```\nThe package relies on the requests library so, in the project, the user must install this library in the requirements.txt file.\n```text\npip3 install requests==2.27.1\n```\n\n\n### Environment Variables\nThe package uses information from the environment variables. They are necessery for functionality of Nortygravity SDK package, used in Northgravity Utils\nEnvironment variables are automatically provided when running a script within a pipeline (as a Task or within the Python/Jupyter Runners).\nIf running locally the script, users must set them in the project to be able to run the project locally.\n\n\nMandatory environment variables to set:\n\n- LOGIN \u2192 login received from NG\n\n- PASSWORD \u2192 password to log in. Credentials are used to generate the token so that each request is authenticated.\n\n- NG_API_ENDPOINT \u2192 the URL to the NG platform API (by default, the url is set to https://api.northgravity.com)\n",
"bugtrack_url": null,
"license": "",
"summary": "Python Utils for NorthGravity platform tasks",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://www.northgravity.com/"
},
"split_keywords": [
"northgravity",
" utils"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2856ea4f9b1009b8dc40aa7c65332aa9a38325e1c078e849491c8bdbb6896099",
"md5": "6f2fb1b953f3a72932cedecfa262d80c",
"sha256": "2168d21a4f48aa9796bc81b2087b53cb0c2ac1b9ac5a7be36f6f5277b12e48eb"
},
"downloads": -1,
"filename": "northgravity_utils-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6f2fb1b953f3a72932cedecfa262d80c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 14482,
"upload_time": "2023-10-26T12:08:18",
"upload_time_iso_8601": "2023-10-26T12:08:18.355232Z",
"url": "https://files.pythonhosted.org/packages/28/56/ea4f9b1009b8dc40aa7c65332aa9a38325e1c078e849491c8bdbb6896099/northgravity_utils-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "117eeca05ff3150e7af8a51f9f582fae39085591f6315d9534d86a28b164192f",
"md5": "fe33c936561017ca0b5b0ed6cc39c0d4",
"sha256": "6d61f802c09d87a10bbb1f30abd48e0d6e472ba2a882e6f479ee2948a7600e67"
},
"downloads": -1,
"filename": "northgravity_utils-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "fe33c936561017ca0b5b0ed6cc39c0d4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 13766,
"upload_time": "2023-10-26T12:08:20",
"upload_time_iso_8601": "2023-10-26T12:08:20.221298Z",
"url": "https://files.pythonhosted.org/packages/11/7e/eca05ff3150e7af8a51f9f582fae39085591f6315d9534d86a28b164192f/northgravity_utils-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-26 12:08:20",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "northgravity-utils"
}
JSON