| Name | askanna JSON |
| Version |
0.24.0
JSON |
| download |
| home_page | |
| Summary | The AskAnna CLI & Python SDK is part of the AskAnna platform to kickstart your data science projects |
| upload_time | 2024-02-21 13:39:10 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | |
| keywords |
ai
askanna
data
datascience
ml
versioncontrol
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# AskAnna CLI & Python SDK
The AskAnna CLI offers a command line interface to the AskAnna platform. With the Python SDK you can run AskAnna
functions directly from your Python script. The CLI & Python SDK simplifies the communication with the AskAnna
platform and provides facilities for supporting every part of a data science project.
[](https://pypi.org/project/askanna/)
[](https://pypi.org/project/askanna/)
[](https://gitlab.com/askanna/askanna-python/-/blob/master/LICENSE)
[](https://docs.askanna.io/)
## Documentation
For the latest information check the [AskAnna Documentation](https://docs.askanna.io/). Or open directly the
documentation for:
* [Command line (CLI)](https://docs.askanna.io/cli/)
* [Python SDK](https://docs.askanna.io/python-sdk/)
## Quickstart
### Install AskAnna
```bash
pip install askanna
```
### Update AskAnna
```bash
pip install -U askanna
```
### Login to AskAnna
```bash
askanna login
```
This will create a `.askanna.yml` in your home directory.
### Authorization token
When the AskAnna CLI & Python SDK is used in for example a CI/CD, one can configure authentication by setting an
environment variable:
```bash
export AA_REMOTE=https://beta-api.askanna.eu
export AA_TOKEN={{ API TOKEN }}
```
The API token can be found in the created `~/.askanna.yml` file after you logged in with `askanna login`.
### How to push code to AskAnna
Run the innit-command on the main directory of your project. The command will create a new project on AskAnna and will
add a `askanna.yml` file to your local project directory. In the `askanna.yml` file you can configure jobs. For more
information, see the [askanna.yml documentation](https://docs.askanna.io/code/#askannayml).
```bash
askanna init
```
If you want to start a project from scratch (or a template), you can run the create-command.
```bash
askanna create
```
With the push-command your code will be uploaded to the project in AskAnna.
```bash
askanna push
```
### Track metrics
To track metrics for your runs, you can use the function `track_metric`. For more information, see the
[metrics documentation](https://docs.askanna.io/metrics/).
```python
from askanna import track_metric
track_metric("name", "value")
```
### Track variables
To track variables for your runs, you can use the function `track_variable`. For more information, see the
[variables documentation](https://docs.askanna.io/variable/tracking/).
```python
from askanna import track_variable
track_variable("name", "value")
```
Raw data
{
"_id": null,
"home_page": "",
"name": "askanna",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "AskAnna Team <support@askanna.io>",
"keywords": "ai,askanna,data,datascience,ml,versioncontrol",
"author": "",
"author_email": "AskAnna Team <support@askanna.io>",
"download_url": "https://files.pythonhosted.org/packages/fb/bf/3f5fb7544e54b2ab001a1259e0079d5f17d3aa2235303a278dc9925ea2af/askanna-0.24.0.tar.gz",
"platform": null,
"description": "# AskAnna CLI & Python SDK\n\nThe AskAnna CLI offers a command line interface to the AskAnna platform. With the Python SDK you can run AskAnna\nfunctions directly from your Python script. The CLI & Python SDK simplifies the communication with the AskAnna\nplatform and provides facilities for supporting every part of a data science project.\n\n[](https://pypi.org/project/askanna/)\n[](https://pypi.org/project/askanna/)\n[](https://gitlab.com/askanna/askanna-python/-/blob/master/LICENSE)\n[](https://docs.askanna.io/)\n\n## Documentation\n\nFor the latest information check the [AskAnna Documentation](https://docs.askanna.io/). Or open directly the\ndocumentation for:\n\n* [Command line (CLI)](https://docs.askanna.io/cli/)\n* [Python SDK](https://docs.askanna.io/python-sdk/)\n\n## Quickstart\n\n### Install AskAnna\n\n```bash\npip install askanna\n```\n\n### Update AskAnna\n\n```bash\npip install -U askanna\n```\n\n### Login to AskAnna\n\n```bash\naskanna login\n```\n\nThis will create a `.askanna.yml` in your home directory.\n\n### Authorization token\n\nWhen the AskAnna CLI & Python SDK is used in for example a CI/CD, one can configure authentication by setting an\nenvironment variable:\n\n```bash\nexport AA_REMOTE=https://beta-api.askanna.eu\nexport AA_TOKEN={{ API TOKEN }}\n```\n\nThe API token can be found in the created `~/.askanna.yml` file after you logged in with `askanna login`.\n\n### How to push code to AskAnna\n\nRun the innit-command on the main directory of your project. The command will create a new project on AskAnna and will\nadd a `askanna.yml` file to your local project directory. In the `askanna.yml` file you can configure jobs. For more\ninformation, see the [askanna.yml documentation](https://docs.askanna.io/code/#askannayml).\n\n```bash\naskanna init\n```\n\nIf you want to start a project from scratch (or a template), you can run the create-command.\n\n```bash\naskanna create\n```\n\nWith the push-command your code will be uploaded to the project in AskAnna.\n\n```bash\naskanna push\n```\n\n### Track metrics\n\nTo track metrics for your runs, you can use the function `track_metric`. For more information, see the\n[metrics documentation](https://docs.askanna.io/metrics/).\n\n```python\nfrom askanna import track_metric\n\ntrack_metric(\"name\", \"value\")\n```\n\n### Track variables\n\nTo track variables for your runs, you can use the function `track_variable`. For more information, see the\n[variables documentation](https://docs.askanna.io/variable/tracking/).\n\n```python\nfrom askanna import track_variable\n\ntrack_variable(\"name\", \"value\")\n```\n",
"bugtrack_url": null,
"license": "",
"summary": "The AskAnna CLI & Python SDK is part of the AskAnna platform to kickstart your data science projects",
"version": "0.24.0",
"project_urls": {
"Changelog": "https://gitlab.com/askanna/askanna-python/-/blob/master/CHANGELOG.md",
"Documentation AskAnna": "https://docs.askanna.io/",
"Documentation CLI": "https://docs.askanna.io/cli/",
"Documentation Python SDK": "https://docs.askanna.io/python-sdk/",
"Homepage": "https://askanna.io",
"Issue Tracker": "https://gitlab.com/askanna/askanna-python/issues",
"Source": "https://gitlab.com/askanna/askanna-python"
},
"split_keywords": [
"ai",
"askanna",
"data",
"datascience",
"ml",
"versioncontrol"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "87fd0d9dafcbfc6917ee2507fd2f0ba10360e78fc6339139dea9b8f9ee1cce84",
"md5": "9df6d29e4fd381c8fc8f2030ac90454b",
"sha256": "47147b5dde4e5d385e1382e0c8be1c3bf4fc3d5f39056fe00d7724ee82347f39"
},
"downloads": -1,
"filename": "askanna-0.24.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9df6d29e4fd381c8fc8f2030ac90454b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 92232,
"upload_time": "2024-02-21T13:39:08",
"upload_time_iso_8601": "2024-02-21T13:39:08.545161Z",
"url": "https://files.pythonhosted.org/packages/87/fd/0d9dafcbfc6917ee2507fd2f0ba10360e78fc6339139dea9b8f9ee1cce84/askanna-0.24.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fbbf3f5fb7544e54b2ab001a1259e0079d5f17d3aa2235303a278dc9925ea2af",
"md5": "4bdfcd1d2525d0d1335d77497bcd36a2",
"sha256": "cab751f3564bb95663bd8dda5a394ec4c8e09ff1499c046bcb060ad413bafa30"
},
"downloads": -1,
"filename": "askanna-0.24.0.tar.gz",
"has_sig": false,
"md5_digest": "4bdfcd1d2525d0d1335d77497bcd36a2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 55502,
"upload_time": "2024-02-21T13:39:10",
"upload_time_iso_8601": "2024-02-21T13:39:10.327766Z",
"url": "https://files.pythonhosted.org/packages/fb/bf/3f5fb7544e54b2ab001a1259e0079d5f17d3aa2235303a278dc9925ea2af/askanna-0.24.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-21 13:39:10",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "askanna",
"gitlab_project": "askanna-python",
"lcname": "askanna"
}
