kiril/WarwickAccomSniper
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add setup instructions to README

Browse Source
This commit is contained in:
Kiril Kovachev 2024-11-04 00:33:41 +00:00
parent 484675bec7
commit 9d46c77d07
1 changed files with 17 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -3,8 +3,23 @@ This script scrapes the Warwick Accommodation page in order to update you whenev
The page typically says (before it opens) that the applications are not yet open, thus, when this is no longer the case 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. (or whenever the page changes at all, for extra caution), the script (the "sniper") can send out a message.
## Usage # Setup
Go to a directory where you want to install the sniper, and do these commands:
```
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. The script is currently quite limited, but you can access it through the `cli_sniper.py` entry point.
`python cli_sniper.py`
To wit:
```
python cli_sniper.py
```
It will only notify you via a terminal output at this stage. A Discord bot is in the works. It will only notify you via a terminal output at this stage. A Discord bot is in the works.