## Hey! - Your AI-powered Pair Programming Friend
> :warning: - You need OpenAI auth token to make Hey work.
> :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://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.
> :package: - Check out <a href="https://pypi.org/project/hey-mindsdb/">Hey on PyPI</a>.
Hey is a CLI-based AI assistant that is powered by the ChatGPT AI model versions supported by [MindsDB](https://mindsdb.com/). This project is designed for [Hashnode X MindsDB](https://hashnode.com/hackathons/mindsdb?source=hncounter-feed) hackathon.
### Installation
Make sure you have `pip` and `python>=3.6` installed on your machine and follow the steps.
<details>
<summary><h4>1. Setup the package</h4></summary>
##### Option A - Download from PyPI archive
```sh
pip install -U hey-mindsdb
```
##### Option B - Download from GitHub archive
```sh
pip install git+http://github.com/lnxpy/hey.git
```
> :warning:: Hey is POSIX-friendly. It might not work properly on the Windows machines at the moment.
</details>
<details>
<summary><h4>2. Set the <code>MINDSDB_EMAIL_ADDRESS</code> environment variable</h4></summary>
Once you got the package installed on your system, it's time to add the `MINDSDB_EMAIL_ADDRESS` environment variable. Create an account on [mindsdb.com](https://mindsdb.com/), train your GPT model and replace your email with `<EMAIL>` in the following options.
##### > If you use the default bash shell
```sh
echo "export MINDSDB_EMAIL_ADDRESS=<EMAIL>" >> ~/.bashrc
```
##### > If you use ZSH
```sh
echo "export MINDSDB_EMAIL_ADDRESS=<EMAIL>" >> ~/.zshrc
```
> :bulb:: Read the article for more information about training your MindsDB model.
</details>
<details>
<summary><h4>3. Set your MindsDB account password</h4></summary>
Now, it's time to set your account's password. Simply run `hey` with the `--auth` option and enter your MindsDB account password.
```sh
hey --auth
```
You're all set to go. :)
</details>
### Usage
Use `hey` followed by your question and it'll process the phrase and responses back the content in Markdown.
```
$ hey generate a power function in javascript
To generate a power function in JavaScript, you can use the built-in Math.pow()
method. Here's an example of how to create a power function using JavaScript:
function powerFunction(base, exponent) {
return Math.pow(base, exponent);
}
// Example usage:
console.log(powerFunction(2, 3)); // Output: 8
console.log(powerFunction(5, 2)); // Output: 25
```
```
$ hey tell me a programming joke
Why do programmers always mix up Christmas and Halloween?
Because Oct 31 == Dec 25!
```
```
$ hey add annotations to this function: $(cat file.py)
To add annotations to the given Python function, you can include comments and
docstrings to provide more information about the function's purpose and usage.
Here's an example:
# Importing the required module from setuptools package
from setuptools import setup
# Function to setup MindsDB package
def mindsdb_setup():
"""
This function sets up the MindsDB package using the setup() function from
setuptools.
"""
# Calling the setup() function to configure the package
setup()
```
### Tech Stack
- Tools
- [Python](https://python.org)
- Infrastructures & Hosting
- [MindsDB](https://mindsdb.com)
- [PyPI](https://pypi.org)
### Package Stats
### License
Hey is being licensed under the [MIT License](https://github.com/lnxpy/hey/blob/main/LICENSE).
### Special Thanks to
[MindsDB](https://mindsdb.com) X [Hashnode](https://hashnode.com) for hosting this great hackathon.
<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": "https://github.com/lnxpy/hey",
"name": "hey-mindsdb",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "hey",
"author": "Sadra Yahyapour",
"author_email": "lnxpylnxpy@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/8d/a5/448f1cafecf6342b08ee2d01577ec21254dc518395d2eab9f55c740ce301/hey_mindsdb-0.2.0.tar.gz",
"platform": null,
"description": "## Hey! - Your AI-powered Pair Programming Friend\n\n> :warning: - You need OpenAI auth token to make Hey work.\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://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\n> :package: - Check out <a href=\"https://pypi.org/project/hey-mindsdb/\">Hey on PyPI</a>.\n\nHey is a CLI-based AI assistant that is powered by the ChatGPT AI model versions supported by [MindsDB](https://mindsdb.com/). This project is designed for [Hashnode X MindsDB](https://hashnode.com/hackathons/mindsdb?source=hncounter-feed) hackathon.\n\n### Installation\nMake sure you have `pip` and `python>=3.6` installed on your machine and follow the steps.\n\n<details>\n <summary><h4>1. Setup the package</h4></summary>\n\n##### Option A - Download from PyPI archive\n```sh\npip install -U hey-mindsdb\n```\n\n##### Option B - Download from GitHub archive\n```sh\npip install git+http://github.com/lnxpy/hey.git\n```\n\n> :warning:: Hey is POSIX-friendly. It might not work properly on the Windows machines at the moment.\n\n</details>\n\n<details>\n <summary><h4>2. Set the <code>MINDSDB_EMAIL_ADDRESS</code> environment variable</h4></summary>\n\nOnce you got the package installed on your system, it's time to add the `MINDSDB_EMAIL_ADDRESS` environment variable. Create an account on [mindsdb.com](https://mindsdb.com/), train your GPT model and replace your email with `<EMAIL>` in the following options.\n\n##### > If you use the default bash shell\n```sh\necho \"export MINDSDB_EMAIL_ADDRESS=<EMAIL>\" >> ~/.bashrc\n```\n##### > If you use ZSH\n```sh\necho \"export MINDSDB_EMAIL_ADDRESS=<EMAIL>\" >> ~/.zshrc\n```\n\n> :bulb:: Read the article for more information about training your MindsDB model.\n\n</details>\n\n<details>\n <summary><h4>3. Set your MindsDB account password</h4></summary>\n\nNow, it's time to set your account's password. Simply run `hey` with the `--auth` option and enter your MindsDB account password.\n\n```sh\nhey --auth\n```\n\nYou're all set to go. :)\n\n</details>\n\n### Usage\nUse `hey` followed by your question and it'll process the phrase and responses back the content in Markdown.\n\n```\n$ hey generate a power function in javascript\nTo generate a power function in JavaScript, you can use the built-in Math.pow()\nmethod. Here's an example of how to create a power function using JavaScript:\n\n\n function powerFunction(base, exponent) {\n return Math.pow(base, exponent);\n }\n\n // Example usage:\n console.log(powerFunction(2, 3)); // Output: 8\n console.log(powerFunction(5, 2)); // Output: 25\n```\n\n```\n$ hey tell me a programming joke\nWhy do programmers always mix up Christmas and Halloween?\n\nBecause Oct 31 == Dec 25!\n```\n\n```\n$ hey add annotations to this function: $(cat file.py)\nTo add annotations to the given Python function, you can include comments and\ndocstrings to provide more information about the function's purpose and usage.\nHere's an example:\n\n\n # Importing the required module from setuptools package\n from setuptools import setup\n\n # Function to setup MindsDB package\n def mindsdb_setup():\n \"\"\"\n This function sets up the MindsDB package using the setup() function from\n setuptools.\n \"\"\"\n # Calling the setup() function to configure the package\n setup()\n```\n\n### Tech Stack\n- Tools\n - [Python](https://python.org)\n- Infrastructures & Hosting\n - [MindsDB](https://mindsdb.com)\n - [PyPI](https://pypi.org)\n\n### Package Stats\n\n\n### License\nHey is being licensed under the [MIT License](https://github.com/lnxpy/hey/blob/main/LICENSE).\n\n### Special Thanks to\n[MindsDB](https://mindsdb.com) X [Hashnode](https://hashnode.com) for hosting this great hackathon.\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",
"summary": "Your AI-powered pair programming friend.",
"version": "0.2.0",
"project_urls": {
"Homepage": "https://github.com/lnxpy/hey"
},
"split_keywords": [
"hey"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8da5448f1cafecf6342b08ee2d01577ec21254dc518395d2eab9f55c740ce301",
"md5": "6b12f5529241f486b65afe1d0ef00108",
"sha256": "e5ce68473b563173a4d43b230be5198416571a358e0ed77d0840d5072709580f"
},
"downloads": -1,
"filename": "hey_mindsdb-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "6b12f5529241f486b65afe1d0ef00108",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 11122,
"upload_time": "2023-12-19T12:51:11",
"upload_time_iso_8601": "2023-12-19T12:51:11.159486Z",
"url": "https://files.pythonhosted.org/packages/8d/a5/448f1cafecf6342b08ee2d01577ec21254dc518395d2eab9f55c740ce301/hey_mindsdb-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-19 12:51:11",
"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"
}
JSON
