https://github.com/vehbiu/kahoot-py
🌐 - A python library for interacting with *Kahoot* live quizzes!
https://github.com/vehbiu/kahoot-py
kahoot kahoot-answers kahoot-bot kahootit pypi python
Last synced: 6 months ago
JSON representation
🌐 - A python library for interacting with *Kahoot* live quizzes!
- Host: GitHub
- URL: https://github.com/vehbiu/kahoot-py
- Owner: vehbiu
- License: gpl-3.0
- Created: 2024-10-12T13:00:36.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-19T01:19:34.000Z (11 months ago)
- Last Synced: 2025-04-06T09:05:52.955Z (6 months ago)
- Topics: kahoot, kahoot-answers, kahoot-bot, kahootit, pypi, python
- Language: Python
- Homepage: https://pypi.org/project/kahoot
- Size: 33.2 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
> **Disclaimer**: This project is not officially affiliated with Kahoot in any way. It is an open-source project created for educational purposes only. Use at your own risk. I bear no responsibility for any misuse of this tool.
# kahoot-py
KahootPy is a Python client for interacting with the Kahoot API, allowing you to join games, send responses, and handle events in real-time.
## 🌟 Features
- **Join Games**: Quickly join Kahoot games using game PINs.
- **Event Handling**: Register handlers for various game events such as questions and game status updates.
- **Real-Time Communication**: Utilize WebSocket connections for real-time interaction with the Kahoot server.
- **User-Friendly**: Simple interface for sending packets and handling game events.
## 🚀 Quick Start
1. Install the package via pip:
```bash
pip install kahoot
```
2. Import and use KahootPy in your Python script:
```python
from kahoot import KahootClient
```
## 🛠️ Example Usage
Here's a basic example of how to use the KahootClient:
**Info**: Check [client_example.py](https://github.com/vehbiu/kahoot-py/blob/main/client_example.py) for an example that correctly utilizes the API
```python
import asyncio
from kahoot import KahootClient
from kahoot.packets.server.question_start import QuestionStartPacket
async def question_start(packet: QuestionStartPacket):
print(f"Question started: {packet}")
async def main():
client = KahootClient()
client.on("question_start", question_start)
await client.join_game(game_pin=3850352, username='your_username')
# Run the main function
asyncio.run(main())
```
### 🎉 Event Handlers
- **Joining a Game**: Use the `join_game` method to join a game with a specific PIN and username.
- **Listening for Events**: Register handlers for various events (e.g., questions, game status) using the `on` method.
## 📁 Project Structure
```
kahoot/
├── __init__.py # Package initialization
├── packets/ # Packet definitions and implementations
├── util/ # Utility functions (e.g., challenge solver, logger)
├── exceptions.py # Custom exceptions
├── constants.py # Constant values (e.g., USER_AGENT)
└── README.md # Documentation
```
## ⚙️ Technical Details
- Built using `httpx` for HTTP requests and `aiocometd` for WebSocket communication.
- Utilizes asynchronous programming with Python's `asyncio` for efficient real-time interaction.
- Modular design with separate packet handling and utility functions for easy maintenance.
## 📝 License
This project is licensed under the GNU GPLv3 License - see the [LICENSE](LICENSE) file for details.
## 🤝 Contributing
Contributions are welcome! Feel free to:
- Open issues
- Submit pull requests
- Suggest new features or improvements
## 👤 Author
**Vehbi**
- GitHub: [@vehbiu](https://github.com/vehbiu)
## 🔒 Responsible Use
This tool is intended for educational and personal use only. Users must ensure compliance with Kahoot's terms of service and applicable laws.
## 🙏 Acknowledgments
- Inspired by the need for real-time interaction with Kahoot's educational games.
## 📊 Stats
---
Made with ❤️ by [@vehbiu](https://github.com/vehbiu)