<img src="https://iili.io/J8wvc1n.png" width="64" height="64" align="right" />
# AskAI
>
> Unleash the Power of AI in Your Terminal
[](https://github.com/yorevs/homesetup)
[](LICENSE.md)
[](docs/CHANGELOG.md#unreleased)
[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=J5CDEFLF6M3H4)
[](https://github.com/yorevs/askai/actions/workflows/build-and-test.yml)
<img src="https://iili.io/J8vkAYX.png" width="100%" height="100%" />
---
<img src="https://iili.io/J8wrBSe.png" width="360" height="360" align="right" />
Born from the idea of empowering individuals with disabilities to navigate the digital world effortlessly, AskAI stands as a beacon of accessibility in the realm of computing. It emerges as a revolutionary solution, harnessing the prowess of AI to bridge the gap between users and the terminal interface. With its intuitive design, AskAI welcomes users of all abilities, eliminating the need for extensive familiarity with shells like bash or zsh. Now, individuals with disabilities can effortlessly command their machines, whether it involves listing files and folders, summarizing documents, accessing real-time data, or delving into a myriad of other functions.
At the heart of AskAI lies its innovative integration of Speech-to-Text and Text-to-Speech technologies, offering a seamless experience for both visually and hearing impaired users. Through these cutting-edge features, individuals can interact with their computers using their natural voice, transcending the barriers imposed by traditional input methods. Moreover, AskAI introduces a unique push-to-talk input mechanism, enabling users to issue commands effortlessly, enhancing the fluidity and ease of interaction.
<img src="https://iili.io/J8wiCqQ.png" style="padding-right: 10px" width="238" height="170" align="left" />
Furthermore, AskAI embraces diversity by breaking language barriers, ensuring that no matter the tongue spoken, users can communicate effectively with their systems. Its adaptive language capabilities ensure that commands are understood and executed accurately, regardless of linguistic nuances. By championing inclusivity on all fronts, AskAI redefines the landscape of computing accessibility, empowering individuals with disabilities to navigate the digital realm with confidence and autonomy.
> The world speaks many languages. AskAI understands them all.
The see a brief demo about AskAI feature check our asciinema video.
[](https://asciinema.org/a/645171)
🔥 **HOT** 🔥 Checkout the [YouTube](https://www.youtube.com/watch?v=ZlVOisiUEvs) video with our Demo!
## Key Features
- Seamlessly Integrate AI Models (Currently Supporting OpenAI).
- Activate Speech-to-Text Inputs via Push-to-Talk Keybinding.
- Control Text-to-Speech Outputs with Adjustable Speed.
- Enable Assistive Technology for Visually Impaired Terminal Usage.
- Enjoy a Natural Typewriter Effect Synced with Speaking Text.
- Automate Offline Language Translations for Enhanced Accessibility.
- Interactive and Non-Interactive modes.
## Installation
### Requirements
#### Python
- Python 3.10 and higher
#### Operating Systems
- Darwin
- High Sierra and higher
- Linux
- Ubuntu 16 and higher
- CentOS 7 and higher
- Fedora 31 and higher
You may want to install HsPyLib on other OS's and it will probably work, but there are no guarantees that it
**WILL ACTUALLY WORK**.
#### Python packages
There are some python dependencies, but they will be automatically downloaded when the build runs. The following python packages are required:
- retry
- pause
- requests
- argostranslate
- soundfile
- langchain
- langchain-openai
- PyAudio
- SpeechRecognition
- openai-whisper
- urllib3
- openai
#### Applications / Libraries
The following software are required:
- FFMPEG (To allow playing audio and video files from your terminal).
- PORTAUDIO (To allow microphone recordings).
##### macOS installation
Use Homebrew to install the prerequisite portaudio:
```bash
$ brew install portaudio ffmpeg
```
##### GNU/Linux installation
Debian-based systems:
```bash
$ sudo apt install python3-pyaudio ffmpeg
```
RedHat-based systems:
```bash
$ sudo dnf install portaudio-devel redhat-rpm-config ffmpeg
```
#### AskAI installation
AskAI is available at [PyPi](https://pypi.org/project/hspylib-askai/)
```bash
$ python3 -m pip install hspylib-askai
```
## Support
> Your support and contributions are greatly appreciated in helping us improve and enhance HomeSetup. Together, we can
make it even better!
You can support HomeSetup by [donating](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=J5CDEFLF6M3H4)
or contributing code. Feel free to contact me for further details. When making code contributions, please make sure to
review our [guidelines](docs/CONTRIBUTING.md) and adhere to our [code of conduct](docs/CODE_OF_CONDUCT.md).
[](https://www.buymeacoffee.com/yorevs)
You can also sponsor it by using our [GitHub Sponsors](https://github.com/sponsors/yorevs) page.
This project is already supported by:
<a href="https://www.jetbrains.com/community/opensource/?utm_campaign=opensource&utm_content=approved&utm_medium=email&utm_source=newsletter&utm_term=jblogo#support">
<img src="https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.png" width="120" height="120">
</a>
Thank you <3 !!
## Contacts
- License: [MIT](LICENSE.md)
- Maintainer: [REDDIT](https://www.reddit.com/user/yorevs)
- Mailto: [HomeSetup](mailto:homesetup@gmail.com)
Enjoy!
Raw data
{
"_id": null,
"home_page": "https://github.com/yorevs/hspylib",
"name": "hspylib-askai",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "ai, openai, application, generative, ask, terminal, ai-terminal-integration",
"author": "Hugo Saporetti Junior",
"author_email": "yorevs@hotmail.com",
"download_url": "https://files.pythonhosted.org/packages/6b/42/67e7f33da5c194d79012355fceadc7f39a177d867bf5d7c3e6ae24ea30b7/hspylib_askai-1.0.6.tar.gz",
"platform": "Darwin",
"description": "<img src=\"https://iili.io/J8wvc1n.png\" width=\"64\" height=\"64\" align=\"right\" />\n\n# AskAI\n>\n> Unleash the Power of AI in Your Terminal\n\n[](https://github.com/yorevs/homesetup)\n[](LICENSE.md)\n[](docs/CHANGELOG.md#unreleased)\n[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=J5CDEFLF6M3H4)\n[](https://github.com/yorevs/askai/actions/workflows/build-and-test.yml)\n\n<img src=\"https://iili.io/J8vkAYX.png\" width=\"100%\" height=\"100%\" />\n\n---\n\n<img src=\"https://iili.io/J8wrBSe.png\" width=\"360\" height=\"360\" align=\"right\" />\n\nBorn from the idea of empowering individuals with disabilities to navigate the digital world effortlessly, AskAI stands as a beacon of accessibility in the realm of computing. It emerges as a revolutionary solution, harnessing the prowess of AI to bridge the gap between users and the terminal interface. With its intuitive design, AskAI welcomes users of all abilities, eliminating the need for extensive familiarity with shells like bash or zsh. Now, individuals with disabilities can effortlessly command their machines, whether it involves listing files and folders, summarizing documents, accessing real-time data, or delving into a myriad of other functions.\n\nAt the heart of AskAI lies its innovative integration of Speech-to-Text and Text-to-Speech technologies, offering a seamless experience for both visually and hearing impaired users. Through these cutting-edge features, individuals can interact with their computers using their natural voice, transcending the barriers imposed by traditional input methods. Moreover, AskAI introduces a unique push-to-talk input mechanism, enabling users to issue commands effortlessly, enhancing the fluidity and ease of interaction.\n\n<img src=\"https://iili.io/J8wiCqQ.png\" style=\"padding-right: 10px\" width=\"238\" height=\"170\" align=\"left\" />\n\nFurthermore, AskAI embraces diversity by breaking language barriers, ensuring that no matter the tongue spoken, users can communicate effectively with their systems. Its adaptive language capabilities ensure that commands are understood and executed accurately, regardless of linguistic nuances. By championing inclusivity on all fronts, AskAI redefines the landscape of computing accessibility, empowering individuals with disabilities to navigate the digital realm with confidence and autonomy.\n\n\n> The world speaks many languages. AskAI understands them all.\n\nThe see a brief demo about AskAI feature check our asciinema video.\n\n[](https://asciinema.org/a/645171)\n\n\ud83d\udd25 **HOT** \ud83d\udd25 Checkout the [YouTube](https://www.youtube.com/watch?v=ZlVOisiUEvs) video with our Demo!\n\n## Key Features\n\n- Seamlessly Integrate AI Models (Currently Supporting OpenAI).\n- Activate Speech-to-Text Inputs via Push-to-Talk Keybinding.\n- Control Text-to-Speech Outputs with Adjustable Speed.\n- Enable Assistive Technology for Visually Impaired Terminal Usage.\n- Enjoy a Natural Typewriter Effect Synced with Speaking Text.\n- Automate Offline Language Translations for Enhanced Accessibility.\n- Interactive and Non-Interactive modes.\n\n## Installation\n\n### Requirements\n\n#### Python\n\n- Python 3.10 and higher\n\n#### Operating Systems\n\n- Darwin\n - High Sierra and higher\n- Linux\n - Ubuntu 16 and higher\n - CentOS 7 and higher\n - Fedora 31 and higher\n\nYou may want to install HsPyLib on other OS's and it will probably work, but there are no guarantees that it\n**WILL ACTUALLY WORK**.\n\n#### Python packages\n\nThere are some python dependencies, but they will be automatically downloaded when the build runs. The following python packages are required:\n\n- retry\n- pause\n- requests\n- argostranslate\n- soundfile\n- langchain\n- langchain-openai\n- PyAudio\n- SpeechRecognition\n- openai-whisper\n- urllib3\n- openai\n\n#### Applications / Libraries\n\nThe following software are required:\n\n- FFMPEG (To allow playing audio and video files from your terminal).\n- PORTAUDIO (To allow microphone recordings).\n\n##### macOS installation\n\nUse Homebrew to install the prerequisite portaudio:\n\n```bash\n$ brew install portaudio ffmpeg\n```\n\n##### GNU/Linux installation\n\nDebian-based systems:\n\n```bash\n$ sudo apt install python3-pyaudio ffmpeg\n```\n\nRedHat-based systems:\n\n```bash\n$ sudo dnf install portaudio-devel redhat-rpm-config ffmpeg\n```\n\n#### AskAI installation\n\nAskAI is available at [PyPi](https://pypi.org/project/hspylib-askai/)\n\n```bash\n$ python3 -m pip install hspylib-askai\n```\n\n## Support\n\n> Your support and contributions are greatly appreciated in helping us improve and enhance HomeSetup. Together, we can\nmake it even better!\n\nYou can support HomeSetup by [donating](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=J5CDEFLF6M3H4)\nor contributing code. Feel free to contact me for further details. When making code contributions, please make sure to\nreview our [guidelines](docs/CONTRIBUTING.md) and adhere to our [code of conduct](docs/CODE_OF_CONDUCT.md).\n\n[](https://www.buymeacoffee.com/yorevs)\n\nYou can also sponsor it by using our [GitHub Sponsors](https://github.com/sponsors/yorevs) page.\n\nThis project is already supported by:\n\n<a href=\"https://www.jetbrains.com/community/opensource/?utm_campaign=opensource&utm_content=approved&utm_medium=email&utm_source=newsletter&utm_term=jblogo#support\">\n <img src=\"https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.png\" width=\"120\" height=\"120\">\n</a>\n\nThank you <3 !!\n\n## Contacts\n\n- License: [MIT](LICENSE.md)\n- Maintainer: [REDDIT](https://www.reddit.com/user/yorevs)\n- Mailto: [HomeSetup](mailto:homesetup@gmail.com)\n\nEnjoy!\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "HomeSetup - AskAI",
"version": "1.0.6",
"project_urls": {
"GitHub": "https://github.com/yorevs/hspylib",
"Homepage": "https://github.com/yorevs/hspylib",
"PyPi": "https://pypi.org/project/hspylib-askai/"
},
"split_keywords": [
"ai",
" openai",
" application",
" generative",
" ask",
" terminal",
" ai-terminal-integration"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a086290bf85922cd1c74cbeec2f86acddb5c5f03dc383149e7c410877ece0db0",
"md5": "486168c59723d2a06cb9cdb5275e506f",
"sha256": "97200308bc44a854855d2d82071c7c5482133ab7e3318c212099fe1486b5e45f"
},
"downloads": -1,
"filename": "hspylib_askai-1.0.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "486168c59723d2a06cb9cdb5275e506f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 79622,
"upload_time": "2024-04-24T04:27:46",
"upload_time_iso_8601": "2024-04-24T04:27:46.985798Z",
"url": "https://files.pythonhosted.org/packages/a0/86/290bf85922cd1c74cbeec2f86acddb5c5f03dc383149e7c410877ece0db0/hspylib_askai-1.0.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6b4267e7f33da5c194d79012355fceadc7f39a177d867bf5d7c3e6ae24ea30b7",
"md5": "f1f99b702bccc39603b0f10c1470835f",
"sha256": "0e70c54eb294c4f1d259ca283a91cd88c57146f1cf3ad06288d1da573ea2c165"
},
"downloads": -1,
"filename": "hspylib_askai-1.0.6.tar.gz",
"has_sig": false,
"md5_digest": "f1f99b702bccc39603b0f10c1470835f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 54133,
"upload_time": "2024-04-24T04:27:49",
"upload_time_iso_8601": "2024-04-24T04:27:49.140863Z",
"url": "https://files.pythonhosted.org/packages/6b/42/67e7f33da5c194d79012355fceadc7f39a177d867bf5d7c3e6ae24ea30b7/hspylib_askai-1.0.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-24 04:27:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "yorevs",
"github_project": "hspylib",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "hspylib-askai"
}
JSON
