Update commands overview and quick start documentation

[nchab6]

To test my changes, run the following command:

git checkout <branch-name>

Then, you can run:

pip install -e .

and test the command.

[github-actions]

test.sh ✅ passed

Full output

============================= test session starts ==============================
platform linux -- Python 3.10.20, pytest-9.0.3, pluggy-1.6.0 -- /opt/hostedtoolcache/Python/3.10.20/x64/bin/python
cachedir: .pytest_cache
rootdir: /home/runner/work/warrior-bot/warrior-bot
configfile: setup.cfg
collecting ... collected 35 items

tests/test_book.py::TestFuzzyScore::test_exact_match_returns_one PASSED  [  2%]
tests/test_book.py::TestFuzzyScore::test_substring_match_scores_high PASSED [  5%]
tests/test_book.py::TestFuzzyScore::test_no_match_scores_low PASSED      [  8%]
tests/test_book.py::TestFuzzyMatchTemplates::test_exact_name_match_first PASSED [ 11%]
tests/test_book.py::TestFuzzyMatchTemplates::test_partial_match_returns_results PASSED [ 14%]
tests/test_book.py::TestFuzzyMatchTemplates::test_no_match_returns_empty PASSED [ 17%]
tests/test_book.py::TestPromptDate::test_rejects_past_date PASSED        [ 20%]
tests/test_book.py::TestPromptDate::test_rejects_date_beyond_max_days_ahead PASSED [ 22%]
tests/test_book.py::TestPromptDate::test_accepts_valid_date_within_range PASSED [ 25%]
tests/test_go.py::test_Academica PASSED                                  [ 28%]
tests/test_go.py::test_Library PASSED                                    [ 31%]
tests/test_go.py::test_Bookstore PASSED                                  [ 34%]
tests/test_go.py::test_Degreeworks PASSED                                [ 37%]
tests/test_go.py::test_Degreeworks_multiword PASSED                      [ 40%]
tests/test_go.py::test_InvalidCommand PASSED                             [ 42%]
tests/test_go.py::test_ExecMsg PASSED                                    [ 45%]
tests/test_go.py::test_Help PASSED                                       [ 48%]
tests/test_go.py::test_NoArgs PASSED                                     [ 51%]
tests/test_help.py::test_help_command_shows_banner PASSED                [ 54%]
tests/test_help.py::test_help_command_shows_usage PASSED                 [ 57%]
tests/test_help.py::test_help_command_lists_commands PASSED              [ 60%]
tests/test_help.py::test_cli_help_flag PASSED                            [ 62%]
tests/test_help.py::test_subcommand_help PASSED                          [ 65%]
tests/test_where.py::test_create_url PASSED                              [ 68%]
tests/test_where.py::test_runtime PASSED                                 [ 71%]
tests/test_where.py::test_html_parser PASSED                             [ 74%]
tests/test_where.py::test_display_all PASSED                             [ 77%]
tests/test_where.py::test_display_errors PASSED                          [ 80%]
tests/test_where.py::test_end_animation PASSED                           [ 82%]
tests/test_where.py::test_building_flag FAILED                           [ 85%]
tests/test_where.py::test_building_shorthand_flag FAILED                 [ 88%]
tests/test_where.py::test_building_maps_url FAILED                       [ 91%]
tests/test_where.py::test_building_nonfunctional_message FAILED          [ 94%]
tests/test_where.py::test_building_runtime PASSED                        [ 97%]
tests/test_where.py::test_building_single_word FAILED                    [100%]

=================================== FAILURES ===================================
______________________________ test_building_flag ______________________________

    def test_building_flag():
        runner = CliRunner()
        result = runner.invoke(where, ["State", "Hall", "-building"])
    
>       assert result.exit_code == 0
E       assert 2 == 0
E        +  where 2 = <Result SystemExit(2)>.exit_code

tests/test_where.py:129: AssertionError
_________________________ test_building_shorthand_flag _________________________

    def test_building_shorthand_flag():
        runner = CliRunner()
        result = runner.invoke(where, ["State", "Hall", "-b"])
    
        assert result.exit_code == 0
>       assert "Flagged as Building" in result.output
E       AssertionError: assert 'Flagged as Building' in '\nBuilding Search Results (1 found)\n\n----------------------------------------\nScience Hall (SCI)\n  Address : 5045 Cass Ave, Detroit, MI 48202\n  Type    : Academic\n  General science programs\n\nCommand took 0.0 seconds\n'
E        +  where '\nBuilding Search Results (1 found)\n\n----------------------------------------\nScience Hall (SCI)\n  Address : 5045 Cass Ave, Detroit, MI 48202\n  Type    : Academic\n  General science programs\n\nCommand took 0.0 seconds\n' = <Result okay>.output

tests/test_where.py:139: AssertionError
____________________________ test_building_maps_url ____________________________

    def test_building_maps_url():
        runner = CliRunner()
        result = runner.invoke(where, ["State", "Hall", "-building"])
    
>       assert "https://maps.wayne.edu/all/" in result.output
E       assert 'https://maps.wayne.edu/all/' in "Usage: where [OPTIONS] [NAME]...\nTry 'where --help' for help.\n\nError: No such option: -u\n"
E        +  where "Usage: where [OPTIONS] [NAME]...\nTry 'where --help' for help.\n\nError: No such option: -u\n" = <Result SystemExit(2)>.output

tests/test_where.py:147: AssertionError
_____________________ test_building_nonfunctional_message ______________________

    def test_building_nonfunctional_message():
        runner = CliRunner()
        result = runner.invoke(where, ["State", "Hall", "-b"])
    
>       assert "non-functional" in result.output
E       AssertionError: assert 'non-functional' in '\nBuilding Search Results (1 found)\n\n----------------------------------------\nScience Hall (SCI)\n  Address : 5045 Cass Ave, Detroit, MI 48202\n  Type    : Academic\n  General science programs\n\nCommand took 0.0 seconds\n'
E        +  where '\nBuilding Search Results (1 found)\n\n----------------------------------------\nScience Hall (SCI)\n  Address : 5045 Cass Ave, Detroit, MI 48202\n  Type    : Academic\n  General science programs\n\nCommand took 0.0 seconds\n' = <Result okay>.output

tests/test_where.py:155: AssertionError
__________________________ test_building_single_word ___________________________

    def test_building_single_word():
        runner = CliRunner()
        result = runner.invoke(where, ["Library", "-b"])
    
        assert result.exit_code == 0
>       assert "Flagged as Building" in result.output
E       AssertionError: assert 'Flagged as Building' in '\nBuilding Search Results (5 found)\n\n----------------------------------------\nPurdy/Kresge Library (PURD)\n  Address : 5265 Cass Ave, Detroit, MI 48202\n  Type    : Library\n  Main university library\n\nDavid Adamany Undergraduate Library (UGLB)\n  Address : 5155 Gullen Mall, Detroit, MI 48202\n  Type    : Library\n  Undergraduate focused library and study space\n\nWalter P. Reuther Library (REU)\n  Address : 5401 Cass Ave, Detroit, MI 48202\n  Type    : Library\n  Archives of labor and urban affairs\n\nArthur Neef Law Library (LAWL)\n  Address : 471 Gilmour Mall, Detroit, MI 48202\n  Type    : Library\n  Law school library and research center\n\nArthur Neef Law Library (LAWL)\n  Address : 474 Ferry Mall, Detroit, MI 48202\n  Type    : Professional\n  Law library\n\nCommand took 0.0 seconds\n'
E        +  where '\nBuilding Search Results (5 found)\n\n----------------------------------------\nPurdy/Kresge Library (PURD)\n  Address : 5265 Cass Ave, Detroit, MI 48202\n  Type    : Library\n  Main university library\n\nDavid Adamany Undergraduate Library (UGLB)\n  Address : 5155 Gullen Mall, Detroit, MI 48202\n  Type    : Library\n  Undergraduate focused library and study space\n\nWalter P. Reuther Library (REU)\n  Address : 5401 Cass Ave, Detroit, MI 48202\n  Type    : Library\n  Archives of labor and urban affairs\n\nArthur Neef Law Library (LAWL)\n  Address : 471 Gilmour Mall, Detroit, MI 48202\n  Type    : Library\n  Law school library and research center\n\nArthur Neef Law Library (LAWL)\n  Address : 474 Ferry Mall, Detroit, MI 48202\n  Type    : Professional\n  Law library\n\nCommand took 0.0 seconds\n' = <Result okay>.output

tests/test_where.py:174: AssertionError
=============================== warnings summary ===============================
tests/test_where.py:27
  /home/runner/work/warrior-bot/warrior-bot/tests/test_where.py:27: PytestUnknownMarkWarning: Unknown pytest.mark.timeout - is this a typo?  You can register custom marks to avoid this warning - for details, see https://docs.pytest.org/en/stable/how-to/mark.html
    @pytest.mark.timeout(15)  # timeout based on non-functional requirements

tests/test_where.py:159
  /home/runner/work/warrior-bot/warrior-bot/tests/test_where.py:159: PytestUnknownMarkWarning: Unknown pytest.mark.timeout - is this a typo?  You can register custom marks to avoid this warning - for details, see https://docs.pytest.org/en/stable/how-to/mark.html
    @pytest.mark.timeout(15)

-- Docs: https://docs.pytest.org/en/stable/how-to/capture-warnings.html
=========================== short test summary info ============================
FAILED tests/test_where.py::test_building_flag - assert 2 == 0
 +  where 2 = <Result SystemExit(2)>.exit_code
FAILED tests/test_where.py::test_building_shorthand_flag - AssertionError: assert 'Flagged as Building' in '\nBuilding Search Results (1 found)\n\n----------------------------------------\nScience Hall (SCI)\n  Address : 5045 Cass Ave, Detroit, MI 48202\n  Type    : Academic\n  General science programs\n\nCommand took 0.0 seconds\n'
 +  where '\nBuilding Search Results (1 found)\n\n----------------------------------------\nScience Hall (SCI)\n  Address : 5045 Cass Ave, Detroit, MI 48202\n  Type    : Academic\n  General science programs\n\nCommand took 0.0 seconds\n' = <Result okay>.output
FAILED tests/test_where.py::test_building_maps_url - assert 'https://maps.wayne.edu/all/' in "Usage: where [OPTIONS] [NAME]...\nTry 'where --help' for help.\n\nError: No such option: -u\n"
 +  where "Usage: where [OPTIONS] [NAME]...\nTry 'where --help' for help.\n\nError: No such option: -u\n" = <Result SystemExit(2)>.output
FAILED tests/test_where.py::test_building_nonfunctional_message - AssertionError: assert 'non-functional' in '\nBuilding Search Results (1 found)\n\n----------------------------------------\nScience Hall (SCI)\n  Address : 5045 Cass Ave, Detroit, MI 48202\n  Type    : Academic\n  General science programs\n\nCommand took 0.0 seconds\n'
 +  where '\nBuilding Search Results (1 found)\n\n----------------------------------------\nScience Hall (SCI)\n  Address : 5045 Cass Ave, Detroit, MI 48202\n  Type    : Academic\n  General science programs\n\nCommand took 0.0 seconds\n' = <Result okay>.output
FAILED tests/test_where.py::test_building_single_word - AssertionError: assert 'Flagged as Building' in '\nBuilding Search Results (5 found)\n\n----------------------------------------\nPurdy/Kresge Library (PURD)\n  Address : 5265 Cass Ave, Detroit, MI 48202\n  Type    : Library\n  Main university library\n\nDavid Adamany Undergraduate Library (UGLB)\n  Address : 5155 Gullen Mall, Detroit, MI 48202\n  Type    : Library\n  Undergraduate focused library and study space\n\nWalter P. Reuther Library (REU)\n  Address : 5401 Cass Ave, Detroit, MI 48202\n  Type    : Library\n  Archives of labor and urban affairs\n\nArthur Neef Law Library (LAWL)\n  Address : 471 Gilmour Mall, Detroit, MI 48202\n  Type    : Library\n  Law school library and research center\n\nArthur Neef Law Library (LAWL)\n  Address : 474 Ferry Mall, Detroit, MI 48202\n  Type    : Professional\n  Law library\n\nCommand took 0.0 seconds\n'
 +  where '\nBuilding Search Results (5 found)\n\n----------------------------------------\nPurdy/Kresge Library (PURD)\n  Address : 5265 Cass Ave, Detroit, MI 48202\n  Type    : Library\n  Main university library\n\nDavid Adamany Undergraduate Library (UGLB)\n  Address : 5155 Gullen Mall, Detroit, MI 48202\n  Type    : Library\n  Undergraduate focused library and study space\n\nWalter P. Reuther Library (REU)\n  Address : 5401 Cass Ave, Detroit, MI 48202\n  Type    : Library\n  Archives of labor and urban affairs\n\nArthur Neef Law Library (LAWL)\n  Address : 471 Gilmour Mall, Detroit, MI 48202\n  Type    : Library\n  Law school library and research center\n\nArthur Neef Law Library (LAWL)\n  Address : 474 Ferry Mall, Detroit, MI 48202\n  Type    : Professional\n  Law library\n\nCommand took 0.0 seconds\n' = <Result okay>.output
=================== 5 failed, 30 passed, 2 warnings in 6.87s ===================

Workflow: 24282992259 · Commit: 2b51a8b