https://github.com/shreyas-a-s/ku-alerts
A website with the goal of making the lives of Kerala University students easier.
https://github.com/shreyas-a-s/ku-alerts
bottlepy btech kerala-university python scraping selectolax vercel
Last synced: 7 months ago
JSON representation
A website with the goal of making the lives of Kerala University students easier.
- Host: GitHub
- URL: https://github.com/shreyas-a-s/ku-alerts
- Owner: shreyas-a-s
- Created: 2025-03-11T17:09:33.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-03-17T18:33:20.000Z (7 months ago)
- Last Synced: 2025-03-17T19:39:21.447Z (7 months ago)
- Topics: bottlepy, btech, kerala-university, python, scraping, selectolax, vercel
- Language: Python
- Homepage: https://ku-alerts.vercel.app
- Size: 76.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Kerala University Alerts
This is a project aimed at simplifying the notification-viewing experience of Kerala University students .
This is a website that runs using [Bottle.py](https://github.com/bottlepy/bottle) on Vercel with Serverless Functions using the [Python Runtime](https://vercel.com/docs/concepts/functions/serverless-functions/runtimes/python). It can also be run locally for testing ang checking it out.
## How it Works
It scrapes the University website's [notifications](https://exams.keralauniversity.ac.in/Login/check1) page using [selectolax](https://github.com/rushter/selectolax), which is a python library that enables easy scraping of html webpages, just like [soup](https://pypi.org/project/beautifulsoup4/) which you might know.
It parses the table of notifications to find the latest notifications that contain the `course` string and it lists them using a neat-looking table which also contains a link to download each of those notifications.
For hosting this website, I have used the Web Server Gateway Interface (WSGI) with [Bottle.py](https://github.com/bottlepy/bottle) to enable handling requests on Vercel with Serverless Functions. This means I am able to run backend code (python) *without* the need for a server, which is pretty cool.
## Running Locally
```bash
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
python3 api/index.py
```
The website is now available at `http://localhost:8080` (the port might be different. Check the terminal window for the correct port number)
## One-Click Deploy
Deploy an example flask/bottle app using [Vercel](https://vercel.com?utm_source=github&utm_medium=readme&utm_campaign=vercel-examples):
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fvercel%2Fexamples%2Ftree%2Fmain%2Fpython%2Fflask3&demo-title=Flask%203%20%2B%20Vercel&demo-description=Use%20Flask%203%20on%20Vercel%20with%20Serverless%20Functions%20using%20the%20Python%20Runtime.&demo-url=https%3A%2F%2Fflask3-python-template.vercel.app%2F&demo-image=https://assets.vercel.com/image/upload/v1669994156/random/flask.png)