/hey

💬 AI-powered Pair Programming Friend for @hashnode X @mindsdb Hackathon!

Primary LanguagePythonMIT LicenseMIT

Hey! - Your AI-powered Pair Programming Friend

:basecamp: - Watch this YouTube introduction video about Hey!

✍️ - Read the "Introducing Hey! - Your AI-powered Pair Programming Friend" article about the creation process, development phases, and a detailed overview of Hey.

📦 - Check out Hey on PyPI.

Hey is a CLI-based AI assistant that is powered by the ChatGPT AI model versions supported by MindsDB. This project is designed for Hashnode X MindsDB hackathon.

Installation

Make sure you have pip and python>=3.6 installed on your machine and follow the steps.

1. Setup the package
Option A - Download from PyPI archive
pip install -U hey-mindsdb
Option B - Download from GitHub archive
pip install git+http://github.com/lnxpy/hey.git

⚠️: Hey is POSIX-friendly. It might not work properly on the Windows machines at the moment.

2. Set the MINDSDB_EMAIL_ADDRESS environment variable

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, train your GPT model and replace your email with <EMAIL> in the following options.

> If you use the default bash shell
echo "export MINDSDB_EMAIL_ADDRESS=<EMAIL>" >> ~/.bashrc
> If you use ZSH
echo "export MINDSDB_EMAIL_ADDRESS=<EMAIL>" >> ~/.zshrc

💡: Read the article for more information about training your MindsDB model.

3. Set your MindsDB account password

Now, it's time to set your account's password. Simply run hey with --set-password followed by your MindsDB account password to set your password.

hey --set-password <PASSWORD>

You're ready to go. :)

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

License

Hey is being licensed under the MIT License.

Special Thanks to

MindsDB X Hashnode for hosting this great hackathon.