Schola

Student-Centric Hub Online Learning Assistant

Schola is a Telegram chatbot designed to assist students in their learning journey. Leveraging OpenAI's language models, Schola allows students to select their subject, take a picture of a question or ask questions directly, and receive detailed answers along with the correct page numbers and references.

Features

• Subject Selection: Choose your subject of interest to get tailored assistance.
• Interactive Q&A: Ask questions via text or by sending a picture of the problem.
• Smart Responses: Get detailed answers powered by OpenAI's language models.
• References: Receive page numbers and references for deeper understanding.

Installation

Prerequisites

• Python 3.10+
• Poetry: Dependency management tool. Install Poetry

Clone the Repository

git clone https://github.com/WildSphee/schola.git 
cd schola

Install Dependencies

Use Poetry to install all dependencies:

pip install poetry
poetry install

This command will create a virtual environment and install all required packages specified in pyproject.toml.

Install LibreOffice

LibreOffice is required for handling certain document types such as .docx, .pptx, and .pdf. To install LibreOffice on a Linux environment, run the following command:

sudo apt update
sudo apt install libreoffice

Environment Variables

Create a .env file in the root directory to store your environment variables:

OPENAI_API_KEY=<your openai api key>
TELEGRAM_EXAM_BOT_TOKEN=<your telegram bot token>

# Azure Form Recognizer
AZURE_FORM_RECOGNIZER_KEY=<your form recognizer key>
AZURE_FORM_RECOGNIZER_ENDPOINT=<your form recognizer endpoint, starting with https>

# Replicate Image Generation
REPLICATE_API_TOKEN=<your replicate api token for image generation>

# Database File Name
DATABASE_NAME=database

Replace the environment variables with your actual keys.

Running the Bot

Start the Telegram bot with:

sh scripts/start.sh

Development

Linting and Type Checking

Ensure your code adheres to the project's style guidelines.

Run Linting Scripts

Execute the linting script:

sh scripts/lint.sh

This script utilizes ruff for linting and mypy for type checking.

Running Tests

Tests are managed using pytest, which is included as a development dependency. To run the tests, use the following command:

pytest

This will automatically discover and run all test files (usually named test_*.py) in the tests/ directory. Make sure you have installed the development dependencies by running:

poetry install --with dev

Running tests regularly ensures that the code remains reliable and that new changes don’t break existing functionality.

Dependencies

Development dependencies are managed under the [tool.poetry.group.dev.dependencies] section in pyproject.toml.

Project Structure

schola/
├── bot.py
├── pyproject.toml
├── README.md
├── scripts/
│   └── lint.sh
└── .env

Scripts

• Linting: sh scripts/lint.sh - Runs code linting and type checks.
• Running Tests: pytest - Discovers and runs all unit tests.

Contact

Developed by Reagan
Email: [email protected]

License

Private License

Acknowledgments

• Thanks to the OpenAI community for continual support.
• Inspired by the need for accessible educational resources.

Contributing

Contributions are welcome! Please open an issue or submit a pull request.

Troubleshooting

If you encounter issues:

• Ensure all environment variables are correctly set in the .env file.
• Verify that dependencies are properly installed with poetry install.
• Check that your Python version is 3.10 or higher.

Future Improvements

• Add unit tests for better reliability.
• Expand subject coverage.
• Implement voice input capabilities.
• Ensure LibreOffice is installed correctly by running libreoffice --version in the terminal.

Happy Learning!