Terminal assistant for Wayne State University students.
warrior-bot is a CLI tool for Wayne State University staff and students. The idea is to make many of the things we need day to day easier to access and use through the terminal.
You can access the documentation here.
To install warrior bot, you can run:
pip install warrior-botFor uv users:
uv install warrior-botFor poetry users:
poetry install warrior-botFor developers, you will find relevant info about how to setup, build and run this project below.
If you're on MacOS, we recommend iTerm2
Ensure you have a version of Python >= 3.10 installed on your machine.
It's best that you use a virtual environment to both develop and test warrior-bot.
python3 -m venv venv # create virtual environment named "venv"
source venv/bin/activate # activate the virtual environment
pip install -r requirements.txt # install all needed libraries to your virtual environment
deactivate # deactivate the environmentTo install the warrior-bot console script, run from root:
pip install -e .Then, you can begin testing/iterating and developing on warrior-bot:
warrior-bot where naresh mahabir
wb go degree works
wb book --b state hallAs a developer, you can install hooks to automatically do things like run black, isort or flake8 on your files before they get committed.
To configure this, we already provide you with a .pre-commit-config.yaml file which will set this up for you. Simply run:
pip install -r requirements-dev.txt # install developer requirements
pre-commit install # install pre-commit cookesNow, whenever you make some changes to your files, these hooks will automatically clean your code up for you or warn you when something looks out of place and allow you to adjust the files before pushing them upstream.
This project is licensed under your choice of either:
- MIT License (LICENSE-MIT)
- Apache License, Version 2.0 (LICENSE-APACHE)
You may choose either license to govern your use of this software.