WarwickAccomSniper/README.md

# Purpose
This script scrapes the Warwick Accommodation page in order to update you whenever the page changes.
The page typically says (before it opens) that the applications are not yet open, thus, when this is no longer the case
(or whenever the page changes at all, for extra caution), the script (the "sniper") can send out a message.

# Setup
Go to a directory where you want to install the sniper, and do these commands:
  ```shell
  git clone https://git.kovachev.xyz/kiril/WarwickAccomSniper
  cd WarwickAccomSniper
  python3 -m venv .venv
  . .venv/bin/activate
  pip install -r requirements.txt
  ```
After that, the setup should be ready and you should be able to run the scripts.

# Usage
The script is currently quite limited, but you can access it through the `cli_sniper.py` entry point.

To wit:
  ```shell
  python cli_sniper.py
```

It will only notify you via a terminal output at this stage. A Discord bot is in the works.