Skip to content

hacettepeoyt/hu-announcement-bot

Repository files navigation

Hacettepe Duyurucusu Banner Hacettepe Duyurucusu Banner

🎉 What is this?

Who really enjoys visiting department websites regularly? Probably nobody. Now it's time to automate it with a Telegram Bot. Hacettepe Duyurucusu offers this simple service to you with no cost.

🦾 How To Contribute?

There are 4 ways of contributing for this project.

🐛 Reporting Problems

This is the place if you are facing an issue while using the bot. To report it, you can use /feedback command and say hi to admins! Even better, you can open an issue on GitHub.

🙏 Feature Requests

If you have anything in your mind about improvements, go ahead and use /feedback. You can also use issue page for it.

🗣 Adding New Languages

Any language even High Valyrian. For a detailed instructions, go ahead and see this.

🈶 Supported Languages

Language Status
🇬🇧 English 🟢 100%
🇫🇷 French 🟢 100%
🇹🇷 Turkish 🟢 100%

💻 Development

If you know a bit Python, I'm sure you can do something.

  • There are lots of departments in Hacettepe University. Hacettepe Duyurucusu doesn't include them all, yet. You can grap a soup from BeautifulSoup, and scrape the department website you want. Don't forget to visit detailed instructions.
  • There might be open issues right now, maybe you know the solution, and you have the free time. Any help is appreciated.
  • You have an idea for a new feature, and you want to add it; I'm waiting for your pull request mate!

🧑‍💻 Development Environment

After cloning the repository, you should create a virtual environment. Python3.11 is recommended but any version higher than or equal to 3.9 should work just fine. Then, install the requirements.

# Clone the repository
git clone git@github.com:hacettepeoyt/hu-announcement-bot.git
cd hu-announcement-bot

# Create a virtual environment with venv and activate it 
python3 -m venv .venv
source .venv/bin/activate

# Install the requirements
pip install -r requirements.txt

Fill the missing configurations in config.toml. Then, run the following command:

python -m src -c <path/to/config.toml> -d <path/to/database.json>

🆕 Changelog

📃 License

GPL-3.0