# Quizen
🎉 **Quizen** is an interactive console application designed to simplify the creation of **Quiz Games**. With a well-structured dictionary, you can set up a quiz in just **3 lines of code**!
🚀 Aimed at both beginners and advanced developers, Quizen offers an intuitive way to integrate educational and entertaining quizzes into your Python projects.
---
## ⚙️ **Features**
- 🧩 **Customizable**: Easily create questions and answers using dictionaries.
- 🎯 **Engaging Gameplay**: Automatic handling of scores, lives, and consecutive correct answers.
- 💾 **Data Persistence**: Player statistics are saved to a file for review.
- 🔀 **Shuffling**: Randomize questions and answers to keep things fresh.
---
## 📦 **Installation**
Install the latest version of **Quizen** from PyPI:
```bash
pip install quizen
```
---
## 🛠 **How to Use**
Using **Quizen** is as simple as this:
### Step 1: Create your questions
Prepare your questions in a JSON file or Python dictionary. For example:
```json
{
"What is the capital of France?": ["Paris", "London", "Berlin", "Madrid"],
"Who developed Python?": ["Guido van Rossum", "Dennis Ritchie", "James Gosling", "Bjarne Stroustrup"]
}
```
### Step 2: Launch your quiz
Here's a complete example to start a quiz:
```python
from quizen import Quiz
from json import load
path = "data/questions.json"
with open(path, "r", encoding="utf-8") as file:
questions = load(file)
Quiz(questions, player="John").play()
```
---
## 📊 **Statistics**
At the end of each game, Quizen displays and saves player statistics, including:
- **Questions answered**
- **Correct answers**
- **Wrong answers**
- **Score**
- **Longest streak of correct answers**
- **Remaining lives**
---
## 🛡 **Dependencies**
Quizen depends on the following libraries:
- [**rich**](https://github.com/Textualize/rich): For beautiful console output.
Install all dependencies automatically with:
```bash
pip install quizen
```
---
## 🏆 **Contributing**
We welcome contributions! Here's how you can help:
1. **Report bugs**: Found a bug? Let us know by opening an issue.
2. **Suggest improvements**: Have ideas for new features? Share them on GitHub.
3. **Submit pull requests**: Fix a bug or implement a feature and submit your PR.
Start by cloning the repository:
```bash
git clone https://github.com/Tostenn/Quizen.git
cd quizen
```
---
## 📣 **Get in Touch**
Your feedback is invaluable! If you encounter issues, have suggestions, or want to contribute, feel free to:
- **Open an issue** on GitHub.
- **Contact me directly** through my [GitHub profile](https://github.com/Tostenn).
Let’s make **Quizen** the ultimate tool for interactive quizzes!
---
Enjoy using **Quizen** and happy coding! 😊
Raw data
{
"_id": null,
"home_page": "https://github.com/Tostenn/Quizen.git",
"name": "quizen",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "kouya tosten",
"author_email": "kouyatosten@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/f5/94/b6a4925eabf84ce85bd4633b05c77d33a005a0357b5bdaddb9a2288e0bbe/quizen-0.2.2.tar.gz",
"platform": null,
"description": "\r\n\r\n# Quizen \r\n\r\n\ud83c\udf89 **Quizen** is an interactive console application designed to simplify the creation of **Quiz Games**. With a well-structured dictionary, you can set up a quiz in just **3 lines of code**! \r\n\r\n\ud83d\ude80 Aimed at both beginners and advanced developers, Quizen offers an intuitive way to integrate educational and entertaining quizzes into your Python projects. \r\n\r\n\r\n\r\n\r\n\r\n\r\n---\r\n\r\n## \u2699\ufe0f **Features** \r\n\r\n- \ud83e\udde9 **Customizable**: Easily create questions and answers using dictionaries. \r\n- \ud83c\udfaf **Engaging Gameplay**: Automatic handling of scores, lives, and consecutive correct answers. \r\n- \ud83d\udcbe **Data Persistence**: Player statistics are saved to a file for review. \r\n- \ud83d\udd00 **Shuffling**: Randomize questions and answers to keep things fresh. \r\n\r\n---\r\n\r\n## \ud83d\udce6 **Installation** \r\n\r\nInstall the latest version of **Quizen** from PyPI: \r\n```bash \r\npip install quizen \r\n``` \r\n\r\n---\r\n\r\n## \ud83d\udee0 **How to Use** \r\n\r\nUsing **Quizen** is as simple as this: \r\n\r\n### Step 1: Create your questions \r\n\r\nPrepare your questions in a JSON file or Python dictionary. For example: \r\n```json \r\n{\r\n \"What is the capital of France?\": [\"Paris\", \"London\", \"Berlin\", \"Madrid\"],\r\n \"Who developed Python?\": [\"Guido van Rossum\", \"Dennis Ritchie\", \"James Gosling\", \"Bjarne Stroustrup\"]\r\n}\r\n``` \r\n\r\n### Step 2: Launch your quiz \r\n\r\nHere's a complete example to start a quiz: \r\n```python \r\nfrom quizen import Quiz \r\nfrom json import load \r\n\r\npath = \"data/questions.json\" \r\n\r\nwith open(path, \"r\", encoding=\"utf-8\") as file: \r\n questions = load(file) \r\n\r\nQuiz(questions, player=\"John\").play() \r\n``` \r\n\r\n---\r\n\r\n## \ud83d\udcca **Statistics** \r\n\r\nAt the end of each game, Quizen displays and saves player statistics, including: \r\n- **Questions answered** \r\n- **Correct answers** \r\n- **Wrong answers** \r\n- **Score** \r\n- **Longest streak of correct answers** \r\n- **Remaining lives** \r\n\r\n---\r\n\r\n## \ud83d\udee1 **Dependencies** \r\n\r\nQuizen depends on the following libraries: \r\n- [**rich**](https://github.com/Textualize/rich): For beautiful console output. \r\n\r\nInstall all dependencies automatically with: \r\n```bash \r\npip install quizen \r\n``` \r\n\r\n---\r\n\r\n## \ud83c\udfc6 **Contributing** \r\n\r\nWe welcome contributions! Here's how you can help: \r\n1. **Report bugs**: Found a bug? Let us know by opening an issue. \r\n2. **Suggest improvements**: Have ideas for new features? Share them on GitHub. \r\n3. **Submit pull requests**: Fix a bug or implement a feature and submit your PR. \r\n\r\nStart by cloning the repository: \r\n```bash \r\ngit clone https://github.com/Tostenn/Quizen.git \r\ncd quizen \r\n``` \r\n\r\n---\r\n\r\n## \ud83d\udce3 **Get in Touch** \r\n\r\nYour feedback is invaluable! If you encounter issues, have suggestions, or want to contribute, feel free to: \r\n- **Open an issue** on GitHub. \r\n- **Contact me directly** through my [GitHub profile](https://github.com/Tostenn). \r\n\r\nLet\u2019s make **Quizen** the ultimate tool for interactive quizzes! \r\n\r\n\r\n---\r\n\r\nEnjoy using **Quizen** and happy coding! \ud83d\ude0a\r\n",
"bugtrack_url": null,
"license": null,
"summary": "Un module pour cr\u00e9er facilement un jeu de quiz",
"version": "0.2.2",
"project_urls": {
"Homepage": "https://github.com/Tostenn/Quizen.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0427587314ea79833ea34051832684444951981cf28d57516998aca068218389",
"md5": "866b4645af3aedc8b0c6bc4677595fd5",
"sha256": "44a5ae5c36c582a4f44d2be03e521ac87abe1cceac03fc44f6ce95cabbb7c3e3"
},
"downloads": -1,
"filename": "quizen-0.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "866b4645af3aedc8b0c6bc4677595fd5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 7691,
"upload_time": "2024-11-18T11:33:51",
"upload_time_iso_8601": "2024-11-18T11:33:51.284560Z",
"url": "https://files.pythonhosted.org/packages/04/27/587314ea79833ea34051832684444951981cf28d57516998aca068218389/quizen-0.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f594b6a4925eabf84ce85bd4633b05c77d33a005a0357b5bdaddb9a2288e0bbe",
"md5": "ea4ca0702c036763c9325eee1ae41d1d",
"sha256": "fcbdb8109031ef6f5b806c98fe08c087a530a129ef258e609473d6c581ea98f4"
},
"downloads": -1,
"filename": "quizen-0.2.2.tar.gz",
"has_sig": false,
"md5_digest": "ea4ca0702c036763c9325eee1ae41d1d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 16395,
"upload_time": "2024-11-18T11:33:52",
"upload_time_iso_8601": "2024-11-18T11:33:52.340018Z",
"url": "https://files.pythonhosted.org/packages/f5/94/b6a4925eabf84ce85bd4633b05c77d33a005a0357b5bdaddb9a2288e0bbe/quizen-0.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-18 11:33:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Tostenn",
"github_project": "Quizen",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "quizen"
}
JSON
