| Name | sovai JSON |
| Version |
0.2.36
JSON |
| download |
| home_page | None |
| Summary | python for asset management |
| upload_time | 2024-11-19 18:52:27 |
| maintainer | None |
| docs_url | None |
| author | Derek Snow |
| requires_python | <4.0,>=3.10 |
| license | Proprietary License |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://github.com/sovai-research/SovAI/actions/workflows/main.yml)
[](https://github.com/sovai-research/SovAI/actions/workflows/python-package.yml)
# SovAI SDK Tool Kit Package
Python SDK Tool Kit, which provides some functions that help you fast receive information from Cloud API.
## Quick start
### Prerequisites:
- Python 3.8+
### Create the main app with authorization
```python
import sovai as sv
# There are three ways how to login to the API
# 1. Configuration API connection
sv.ApiConfig.token = "super_secret_token"
sv.ApiConfig.base_url = "https://google.com"
# 2. Read token from .env file e.g API_TOKEN=super_secret_token
sv.read_key('.env')
# 3. The Basic authentication method
sv.basic_auth("test@test.com", "super_strong_password")
# And then continue working with get some data from API and manipulating them
```
### Retrieve data from different endpoints from the API server
```python
# Retrieve data
gs_df = sv.get("bankruptcy/monthly", params={"version": 20221013})
```
### Retrieve charts data with plotting graphs
```python
# Retrieve data with plotting special flag `plot=True`
data_pca = sv.get(
endpoint="bankruptcy/charts", params={"tickers": "A", "chart": "pca"}, plot=True
)
```
Raw data
{
"_id": null,
"home_page": null,
"name": "sovai",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": null,
"author": "Derek Snow",
"author_email": "d.snow@outlook.com",
"download_url": "https://files.pythonhosted.org/packages/f0/5f/7b726360749452b2cb33ab741d9f94931cf6dc52a6f9f45a493de3ef95d8/sovai-0.2.36.tar.gz",
"platform": null,
"description": "[](https://github.com/sovai-research/SovAI/actions/workflows/main.yml) \n[](https://github.com/sovai-research/SovAI/actions/workflows/python-package.yml)\n\n# SovAI SDK Tool Kit Package\n\nPython SDK Tool Kit, which provides some functions that help you fast receive information from Cloud API.\n\n## Quick start\n\n### Prerequisites:\n\n- Python 3.8+\n\n### Create the main app with authorization\n\n```python\nimport sovai as sv\n\n# There are three ways how to login to the API\n\n# 1. Configuration API connection\nsv.ApiConfig.token = \"super_secret_token\"\nsv.ApiConfig.base_url = \"https://google.com\"\n\n# 2. Read token from .env file e.g API_TOKEN=super_secret_token\nsv.read_key('.env')\n\n# 3. The Basic authentication method\nsv.basic_auth(\"test@test.com\", \"super_strong_password\")\n\n# And then continue working with get some data from API and manipulating them\n```\n\n### Retrieve data from different endpoints from the API server\n\n```python\n# Retrieve data\ngs_df = sv.get(\"bankruptcy/monthly\", params={\"version\": 20221013})\n```\n\n### Retrieve charts data with plotting graphs\n\n```python\n# Retrieve data with plotting special flag `plot=True`\ndata_pca = sv.get(\n endpoint=\"bankruptcy/charts\", params={\"tickers\": \"A\", \"chart\": \"pca\"}, plot=True\n)\n```\n",
"bugtrack_url": null,
"license": "Proprietary License",
"summary": "python for asset management",
"version": "0.2.36",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e01af156145a41175fbf864cd595dceb18dcc25324bb3d60b389177f98ef084b",
"md5": "b25d90c2b02baf9928ac16854ef7bb6c",
"sha256": "b6a864284205c37192efcf128087a52bfa0cd9281e8177c922d8122fdbaada8f"
},
"downloads": -1,
"filename": "sovai-0.2.36-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b25d90c2b02baf9928ac16854ef7bb6c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 241573,
"upload_time": "2024-11-19T18:52:25",
"upload_time_iso_8601": "2024-11-19T18:52:25.688070Z",
"url": "https://files.pythonhosted.org/packages/e0/1a/f156145a41175fbf864cd595dceb18dcc25324bb3d60b389177f98ef084b/sovai-0.2.36-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f05f7b726360749452b2cb33ab741d9f94931cf6dc52a6f9f45a493de3ef95d8",
"md5": "8f0cd07efe5413808a0369220a250c9e",
"sha256": "390ec6cece7ab3f1a04deca8945c1923472dbd90c36fad93ca116fc3c4ad78ba"
},
"downloads": -1,
"filename": "sovai-0.2.36.tar.gz",
"has_sig": false,
"md5_digest": "8f0cd07efe5413808a0369220a250c9e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 202243,
"upload_time": "2024-11-19T18:52:27",
"upload_time_iso_8601": "2024-11-19T18:52:27.319281Z",
"url": "https://files.pythonhosted.org/packages/f0/5f/7b726360749452b2cb33ab741d9f94931cf6dc52a6f9f45a493de3ef95d8/sovai-0.2.36.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-19 18:52:27",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "sovai"
}
