# advanced-askai
[](../../actions/workflows/lint.yml)
[](../../actions/workflows/push_macos.yml)
[](../../actions/workflows/push_ubuntu.yml)
[](../../actions/workflows/push_win.yml)
This package allows you to have a chat conversation with AI right from your terminal.
Results are streamed to the console.
It has api bindings to allow programatic access and can be used for other tools.
The api key is stored using the secure keyring package. Right now we only support
OpenAI's chatbot, but in the future I hope to include support for anthropics.
The only stable api in this package is located at `advanced_askai.api`
Binding to any other module in this library is subject to break.
# Help
```
usage: Ask OpenAI for help with code
positional arguments:
prompt Prompt to ask OpenAI
options:
-h, --help show this help message and exit
--input-file INPUT_FILE
Input file containing prompts
--json Print response as json
--set-key SET_KEY Set OpenAI key
--output OUTPUT Output file
--advanced bleeding edge model: gpt-4o
--model MODEL
--verbose
--no-stream
--assistant-prompt ASSISTANT_PROMPT
--assistant-prompt-file ASSISTANT_PROMPT_FILE
File containing assistant prompt
--max-tokens MAX_TOKENS
Max tokens to return
--code Code mode: enables aider mode
--check Sends the response back to the chatbot for a second opinion
```
See advanced_askai.api.*
# Develope
To develop software, run `. ./activate.sh`
# Windows
This environment requires you to use `git-bash`.
# Linting
Run `./lint.sh` to find linting errors using `pylint`, `flake8` and `mypy`.
# Releases
* 1.0.2 - Fixes openai dependency break: `openai>=1.3.7,<=1.55.3`
* 1.0.1 - If the max tokens goes negative, just set it to 16000.
Raw data
{
"_id": null,
"home_page": "https://github.com/zackees/askai",
"name": "advanced-askai",
"maintainer": "Zachary Vorhies",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "template-python-cmd",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/33/a6/20995e581059e3a625e5862c89a6a3acb035b247d47061e59f966278dc41/advanced_askai-1.0.2.tar.gz",
"platform": null,
"description": "# advanced-askai\r\n\r\n[](../../actions/workflows/lint.yml)\r\n\r\n[](../../actions/workflows/push_macos.yml)\r\n[](../../actions/workflows/push_ubuntu.yml)\r\n[](../../actions/workflows/push_win.yml)\r\n\r\nThis package allows you to have a chat conversation with AI right from your terminal.\r\n\r\nResults are streamed to the console.\r\n\r\nIt has api bindings to allow programatic access and can be used for other tools.\r\n\r\nThe api key is stored using the secure keyring package. Right now we only support\r\nOpenAI's chatbot, but in the future I hope to include support for anthropics.\r\n\r\nThe only stable api in this package is located at `advanced_askai.api`\r\n\r\nBinding to any other module in this library is subject to break.\r\n\r\n# Help\r\n\r\n```\r\nusage: Ask OpenAI for help with code\r\n\r\npositional arguments:\r\n prompt Prompt to ask OpenAI\r\n\r\noptions:\r\n -h, --help show this help message and exit\r\n --input-file INPUT_FILE\r\n Input file containing prompts\r\n --json Print response as json\r\n --set-key SET_KEY Set OpenAI key\r\n --output OUTPUT Output file\r\n --advanced bleeding edge model: gpt-4o\r\n --model MODEL\r\n --verbose\r\n --no-stream\r\n --assistant-prompt ASSISTANT_PROMPT\r\n --assistant-prompt-file ASSISTANT_PROMPT_FILE\r\n File containing assistant prompt\r\n --max-tokens MAX_TOKENS\r\n Max tokens to return\r\n --code Code mode: enables aider mode\r\n --check Sends the response back to the chatbot for a second opinion\r\n```\r\n\r\nSee advanced_askai.api.*\r\n\r\n# Develope\r\n\r\nTo develop software, run `. ./activate.sh`\r\n\r\n# Windows\r\n\r\nThis environment requires you to use `git-bash`.\r\n\r\n# Linting\r\n\r\nRun `./lint.sh` to find linting errors using `pylint`, `flake8` and `mypy`.\r\n\r\n\r\n# Releases\r\n\r\n * 1.0.2 - Fixes openai dependency break: `openai>=1.3.7,<=1.55.3`\r\n * 1.0.1 - If the max tokens goes negative, just set it to 16000.\r\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License",
"summary": "askai questions on the command line",
"version": "1.0.2",
"project_urls": {
"Homepage": "https://github.com/zackees/askai"
},
"split_keywords": [
"template-python-cmd"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0db2683dde82ee3bcd4e7ac2d8a42407bea74ebe454edaad475e4dfe59b7fc26",
"md5": "65dc25f58533431db258222a6e549d2e",
"sha256": "4812c808a6ded9fed755a1eaf6ba78025551edeea5b69efc098495603323d706"
},
"downloads": -1,
"filename": "advanced_askai-1.0.2-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "65dc25f58533431db258222a6e549d2e",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.7",
"size": 15708,
"upload_time": "2024-12-29T01:08:49",
"upload_time_iso_8601": "2024-12-29T01:08:49.075168Z",
"url": "https://files.pythonhosted.org/packages/0d/b2/683dde82ee3bcd4e7ac2d8a42407bea74ebe454edaad475e4dfe59b7fc26/advanced_askai-1.0.2-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "33a620995e581059e3a625e5862c89a6a3acb035b247d47061e59f966278dc41",
"md5": "23bdef190597cf63ff5c3528997d09d9",
"sha256": "d7bad46b978dc0fe85ec7e5fd9b5a9c8a12bca5a832b2d4caf5ff48c7c9baed1"
},
"downloads": -1,
"filename": "advanced_askai-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "23bdef190597cf63ff5c3528997d09d9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 21624,
"upload_time": "2024-12-29T01:08:50",
"upload_time_iso_8601": "2024-12-29T01:08:50.362233Z",
"url": "https://files.pythonhosted.org/packages/33/a6/20995e581059e3a625e5862c89a6a3acb035b247d47061e59f966278dc41/advanced_askai-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-29 01:08:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "zackees",
"github_project": "askai",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"tox": true,
"lcname": "advanced-askai"
}
JSON
