https://github.com/harrislapiroff/help-bot

Yet another GPT Powered Assistant
https://github.com/harrislapiroff/help-bot

Last synced: 1 day ago
JSON representation

Yet another GPT Powered Assistant

• Host: GitHub
• URL: https://github.com/harrislapiroff/help-bot
• Owner: harrislapiroff
• Created: 2023-04-07T06:55:57.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-11-29T01:39:36.000Z (about 1 year ago)
• Last Synced: 2024-11-25T12:44:18.690Z (2 months ago)
• Language: Python
• Homepage:
• Size: 370 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Help Bot

Yet another GPT-powered assistant.

![Screenshot of a conversation with the help bot in a terminal](preview.png)

Prerequisites

-------------

Running Help Bot requires [Poetry](https://python-poetry.org/). You can install it with `pip install poetry`.

Usage

-----

To use Help Bot:

1. Clone this repository.

2. Install the requirements with `poetry install`.

3. Recommended: Set up environment variables

   a. Install the poetry dotenv plugin with `poetry self add poetry-dotenv-plugin`. You could use a different method to load environment variables, but this is the easiest.

   b. Create a `.env` file in the root of the repository with the following contents:

      ```dotenv

      OPENAI_API_KEY=your_openai_api_key

      # Optional: Only if using a Discord bot

      DISCORD_BOT_TOKEN=your_discord_token

      DISCORD_DM_ALLOWLIST="comma,separated,list,of,users,in,user#555,format"

      ```

4. Run the bot with either `poetry run shell`, for a shell-based bot, or `poetry run discord`, for a Discord-based one.

If you need an OpenAI API key, you can get one [here](https://platform.openai.com/account/api-keys).

If you need a Discord bot token, you can get one [here](https://discord.com/developers/applications). Create a new application, then create a bot user and copy the token.