Metadata-Version: 2.3
Name: student-bluebook
Version: 0.6.0
Summary: Blue Book is an application that uses AI to generate multiple-choice questions to prepare for CompTIA Security+ exam
Author: Ilya Smut
Author-email: ilya.smut.off.g@gmail.com
Requires-Python: >=3.10
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: bleach (>=6.2.0,<7.0.0)
Requires-Dist: click (>=8.1.8,<9.0.0)
Requires-Dist: flask (>=3.1.0,<4.0.0)
Requires-Dist: google-genai (>=1.2.0,<2.0.0)
Requires-Dist: pydantic (>=2.10.6,<3.0.0)
Requires-Dist: sqlmodel (>=0.0.24,<0.0.25)
Project-URL: Documentation, https://github.com/ilya-smut/blue-book/wiki
Project-URL: Homepage, https://student-bluebook.notion.site/
Project-URL: Repository, https://github.com/ilya-smut/blue-book
Description-Content-Type: text/markdown

![Bluebook Logo](https://github.com/ilya-smut/blue-book/blob/main/bluebook/static/images/book.png?raw=true)
# Blue Book
![demo-gif](https://github.com/ilya-smut/blue-book/blob/main/examples/videos/bluebook%20gif.gif?raw=true)

Blue Book is an application that generates multiple-choice questions for CompTIA Security+ preparation at the press of a button. It uses the Gemini API to generate questions and provides instant feedback on answers.

[Project's Homepage](https://student-bluebook.notion.site/)

## Features
- Generate CompTIA Security+ multiple-choice questions.
- Specify the topic you want to the questions to focus on.
- Save the chosen topic for future use. Access saved topics.
- Submit answers and receive immediate feedback.
- Get explanation of correct and incorrect answers to enhance learning.
- Save questions for revision.
- App can be run in a docker container with minimal setup.

## Installation

You can install bluebook with pip:
   ```sh
   pip install student-bluebook
   ```

With pipx
   ```sh
   pipx install student-bluebook
   ```

Or you can simply run it in a docker container
   ```sh
   docker run -d -p 5000:5000 --platform linux/amd64 ilyasmut/student-bluebook
   ```
   or
   ```sh
   git clone https://github.com/ilya-smut/blue-book
   cd blue-book/
   docker compose up -d
   ```

## Usage

Please see bluebook's interface and capabilities on this wiki page [wiki page](https://github.com/ilya-smut/blue-book/wiki):

To start the application, use the following command:
```sh
bluebook start
```

## Contributing
If you’d like to contribute to Blue Book, feel free to submit a pull request or open an issue.

## License
This project is licensed under the GPLv3

## Contact
For any questions or feedback, feel free to reach out.


