tamuGPT

Prerequisites

• Install Python (>3.9)

Project Installation

1. Clone the repository - git clone <remote-url>
2. Go to the project directory - cd <cloned-repo>
3. Set up the environment:
   • Create a virtual environment - python3 -m venv venv
   • Activate the virtual environment:
     • Linux: source venv/bin/activate
     • Windows: venv\Scripts\activate
4. Install the dependencies - pip3 install -r requirements.txt
5. Install pre-commit - pre-commit install
6. Copy contents of .env.example to a new file .env - cp .env.example .env
   • Fill in the below environment variables
     • OPENAI_API_KEY: Get OpenAI API key here
     • GOOGLE_CSE_ID: Get Google Custom Search JSON API here
     • GOOGLE_CSE_API_KEY: Get Google Search Engine ID here
7. Configure config.py file if needed

Code formatting

Pre-commit hooks automatically format the code using autopep8 when you do git commit.