warrior-bot

Terminal assistant for Wayne State University students.

Welcome!

If you're here to contribute, skip ahead to Getting Started. If you just want to try it out, follow the steps below!

Installation

For now, install and run the program using the following command from the root directory. We hope to come out with our pilot version in the near future which will give you access via pip, uv and poetry.

pip install -e .

Usage

warrior-bot where is panda express
warrior-bot what is the wifi name
warrior-bot --help

Requirements

• Python 3.10+
• Access to a terminal
• Recommended
  • Ghostty
  • Alacritty
  • Kitty
  • WezTerm

If you're on MacOS, we also recommend iTerm2

Development

Getting Started

Read the Contribution Setup and Guidelines to get started.

Quick Setup

1. Clone the repo
2. Setup and Activate your Virtual Environment
3. bash pip install pre-commit pre-commit install
4. Create your branch, develop your bug fix, feature or other contribution
5. Open PR and a reviewer will approve your additions or request changes/
6. Optionally, you may run pre-commit run --all-files to run checks manually before pushing your changes.