| Name | hey-mindsdb JSON |
| Version |
0.4.0
JSON |
| download |
| home_page | None |
| Summary | Your AI-powered pair programming friend |
| upload_time | 2024-09-16 22:56:26 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2023, Sadra Yahyapour Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
## Hey! - Your AI-powered Pair Programming Friend
<a href="https://www.producthunt.com/posts/hey-7fed5187-9b92-4ee8-9ce5-e08d5bc63d15?embed=true&utm_source=badge-featured&utm_medium=badge&utm_souce=badge-hey-7fed5187-9b92-4ee8-9ce5-e08d5bc63d15" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=483008&theme=light" alt="Hey! - AI-Powered Pair Programming Friend! ✨ | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a> <a href="https://www.producthunt.com/posts/hey-7fed5187-9b92-4ee8-9ce5-e08d5bc63d15?embed=true&utm_source=badge-top-post-badge&utm_medium=badge&utm_souce=badge-hey-7fed5187-9b92-4ee8-9ce5-e08d5bc63d15" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/top-post-badge.svg?post_id=483008&theme=light&period=daily" alt="Hey! - AI-powered pair programming friend | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>
> :basecamp: - Watch this YouTube <a href="https://www.youtube.com/watch?v=fhO34PVa-38&list=LL&index=9">introduction video</a> about Hey!
> :writing_hand: - Read the <a href="https://blog.imsadra.me/introducing-hey-your-ai-powered-pair-programming-friend">"Introducing Hey! - Your AI-powered Pair Programming Friend"</a> article about the creation process, development phases, and a detailed overview of Hey.
Hey is a free CLI-based AI assistant that is powered by the LLMs. You can set which LLM service you want to connect Hey to.
> [!TIP]
> We recommend using the free tokens provided by MindsDB. You can generate one for your personal uses for free on [mdb.ai](https://mdb.ai). You can set Hey to interact with any other LLM service though. You're not limited to mdb.ai. It's a recommendation.
### Installation
Make sure you have `pip` and `python>=3.8` installed on your machine and follow the steps.
#### 1. Setup the package
###### Option A - Download from PyPI
```sh
pip install -U hey-mindsdb
```
###### Option B - Download from the repository
```sh
pip install git+http://github.com/lnxpy/hey.git
```
#### 2. Set the token
Once you got the package installed on your system, it's time to set the token into hey. Run the following command to set the token.
```sh
hey auth
```
</details>
### Usage
There are different commands and sub-commands implemented once you install `hey`. Check them out via the `--help` flag.
```sh
hey --help
```
#### TLDR;
- If you want to use `Hey` in a fast and quick way, use the `ask` command.
```sh
hey ask "explain the duality term in quantum physics."
```
- If your question needs more explanations with code snippets maybe, then just `hey`.
```sh
hey
<OPENS EDITOR>
```
> Keep in mind that when you run `hey` with no sub-commands, the default `$EDITOR` will be used. If this environment variable is not set, then `vim` on Unix-like systems and `notepad` on Windows machines will be used by default.
### Configuration
There is a command dedicated for more customizability. Check the following bullet-points.
- Create a base configuration file.
```sh
hey config create
```
- View and edit the configuration file.
```sh
hey config edit
```
Here is more information about each configuration parameter.
```json
{
// llm service URL
"service": "https://llm.mdb.ai",
// model version
"model": "gpt-3.5-turbo",
// prompt
"prompt": "Answer in a helpful way.",
// themes used for the codeblocks
"code_block_theme": "github-light",
// how would you like `hey` to think?
"loading_text": "Thinking..",
// check out full list: python -m rich.spinner
"loading_spinner": "dots",
// never style the output (in case you need to copy the result)
"never_style": false
}
```
### License
Hey is being licensed under the [MIT License](https://github.com/lnxpy/hey/blob/main/LICENSE).
### Shout-out to
Hey! was created for a hackathon partnering [MindsDB](https://mindsdb.com) X [Hashnode](https://hashnode.com).
<img src="media/badge-dark.svg#gh-dark-mode-only" width=350 height=90>
<img src="media/badge-light.svg#gh-light-mode-only" width=350 height=90>
Raw data
{
"_id": null,
"home_page": null,
"name": "hey-mindsdb",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Sadra Yahyapour <lnxpylnxpy@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/61/21/bd40b1f245857be19bad57425ed66608e9c986de2deea01d75d4042109c9/hey_mindsdb-0.4.0.tar.gz",
"platform": null,
"description": "## Hey! - Your AI-powered Pair Programming Friend\n\n<a href=\"https://www.producthunt.com/posts/hey-7fed5187-9b92-4ee8-9ce5-e08d5bc63d15?embed=true&utm_source=badge-featured&utm_medium=badge&utm_souce=badge-hey-7fed5187-9b92-4ee8-9ce5-e08d5bc63d15\" target=\"_blank\"><img src=\"https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=483008&theme=light\" alt=\"Hey! - AI-Powered Pair Programming Friend! \u2728 | Product Hunt\" style=\"width: 250px; height: 54px;\" width=\"250\" height=\"54\" /></a> <a href=\"https://www.producthunt.com/posts/hey-7fed5187-9b92-4ee8-9ce5-e08d5bc63d15?embed=true&utm_source=badge-top-post-badge&utm_medium=badge&utm_souce=badge-hey-7fed5187-9b92-4ee8-9ce5-e08d5bc63d15\" target=\"_blank\"><img src=\"https://api.producthunt.com/widgets/embed-image/v1/top-post-badge.svg?post_id=483008&theme=light&period=daily\" alt=\"Hey! - AI-powered pair programming friend | Product Hunt\" style=\"width: 250px; height: 54px;\" width=\"250\" height=\"54\" /></a>\n\n> :basecamp: - Watch this YouTube <a href=\"https://www.youtube.com/watch?v=fhO34PVa-38&list=LL&index=9\">introduction video</a> about Hey!\n\n> :writing_hand: - Read the <a href=\"https://blog.imsadra.me/introducing-hey-your-ai-powered-pair-programming-friend\">\"Introducing Hey! - Your AI-powered Pair Programming Friend\"</a> article about the creation process, development phases, and a detailed overview of Hey.\n\nHey is a free CLI-based AI assistant that is powered by the LLMs. You can set which LLM service you want to connect Hey to.\n\n> [!TIP]\n> We recommend using the free tokens provided by MindsDB. You can generate one for your personal uses for free on [mdb.ai](https://mdb.ai). You can set Hey to interact with any other LLM service though. You're not limited to mdb.ai. It's a recommendation.\n\n### Installation\nMake sure you have `pip` and `python>=3.8` installed on your machine and follow the steps.\n\n#### 1. Setup the package\n\n###### Option A - Download from PyPI\n```sh\npip install -U hey-mindsdb\n```\n\n###### Option B - Download from the repository\n```sh\npip install git+http://github.com/lnxpy/hey.git\n```\n\n#### 2. Set the token\nOnce you got the package installed on your system, it's time to set the token into hey. Run the following command to set the token.\n\n```sh\nhey auth\n```\n</details>\n\n### Usage\nThere are different commands and sub-commands implemented once you install `hey`. Check them out via the `--help` flag.\n\n```sh\nhey --help\n```\n\n#### TLDR;\n\n- If you want to use `Hey` in a fast and quick way, use the `ask` command.\n\n ```sh\n hey ask \"explain the duality term in quantum physics.\"\n ```\n\n- If your question needs more explanations with code snippets maybe, then just `hey`.\n\n ```sh\n hey\n <OPENS EDITOR>\n ```\n\n > Keep in mind that when you run `hey` with no sub-commands, the default `$EDITOR` will be used. If this environment variable is not set, then `vim` on Unix-like systems and `notepad` on Windows machines will be used by default.\n\n### Configuration\nThere is a command dedicated for more customizability. Check the following bullet-points.\n\n- Create a base configuration file.\n\n ```sh\n hey config create\n ```\n\n- View and edit the configuration file.\n\n ```sh\n hey config edit\n ```\n\nHere is more information about each configuration parameter.\n\n```json\n{\n // llm service URL\n \"service\": \"https://llm.mdb.ai\",\n\n // model version\n \"model\": \"gpt-3.5-turbo\",\n\n // prompt\n \"prompt\": \"Answer in a helpful way.\",\n\n // themes used for the codeblocks\n \"code_block_theme\": \"github-light\",\n\n // how would you like `hey` to think?\n \"loading_text\": \"Thinking..\",\n\n // check out full list: python -m rich.spinner\n \"loading_spinner\": \"dots\",\n\n // never style the output (in case you need to copy the result)\n \"never_style\": false\n}\n```\n\n### License\nHey is being licensed under the [MIT License](https://github.com/lnxpy/hey/blob/main/LICENSE).\n\n### Shout-out to\nHey! was created for a hackathon partnering [MindsDB](https://mindsdb.com) X [Hashnode](https://hashnode.com).\n\n<img src=\"media/badge-dark.svg#gh-dark-mode-only\" width=350 height=90>\n<img src=\"media/badge-light.svg#gh-light-mode-only\" width=350 height=90>\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023, Sadra Yahyapour Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Your AI-powered pair programming friend",
"version": "0.4.0",
"project_urls": {
"Repository": "https://github.com/lnxpy/hey"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a9d0ac4e4c8d7edda708fb7439ce0d123c44616c776ba775666945cf3b393783",
"md5": "3829ced1ef0254dacd28f250a94cfa6b",
"sha256": "9a75da360a4bd2d4fc05adc665de22dd408e4b47a3be3d076581e7f1a44b1da7"
},
"downloads": -1,
"filename": "hey_mindsdb-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3829ced1ef0254dacd28f250a94cfa6b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 9753,
"upload_time": "2024-09-16T22:56:25",
"upload_time_iso_8601": "2024-09-16T22:56:25.183942Z",
"url": "https://files.pythonhosted.org/packages/a9/d0/ac4e4c8d7edda708fb7439ce0d123c44616c776ba775666945cf3b393783/hey_mindsdb-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6121bd40b1f245857be19bad57425ed66608e9c986de2deea01d75d4042109c9",
"md5": "a74046e877863b413a62af2056270a65",
"sha256": "82d826bb91d99d03c6dfaf864558b3d7b941f60e208533f2b3935e657149b186"
},
"downloads": -1,
"filename": "hey_mindsdb-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "a74046e877863b413a62af2056270a65",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 43867,
"upload_time": "2024-09-16T22:56:26",
"upload_time_iso_8601": "2024-09-16T22:56:26.437217Z",
"url": "https://files.pythonhosted.org/packages/61/21/bd40b1f245857be19bad57425ed66608e9c986de2deea01d75d4042109c9/hey_mindsdb-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-16 22:56:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "lnxpy",
"github_project": "hey",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "hey-mindsdb"
}
