baicai-tutor 0.1.0

AI tutor for Everyone

Baicai Tutor

An AI-powered tutoring system designed to provide personalized learning experiences for everyone.

Overview

Baicai Tutor is an intelligent tutoring system that leverages advanced AI technologies to create adaptive and engaging learning experiences. It's built on top of the Baicai Base framework and aims to make quality education accessible to all.

Features

• AI-powered personalized tutoring
• Adaptive learning paths
• Interactive learning experiences
• Comprehensive knowledge base
• Real-time feedback and assessment

Requirements

• Python 3.10 or higher (but less than 3.12)
• Poetry for dependency management

Installation

1. Clone the repository:

git clone https://github.com/yourusername/baicai_tutor.git
cd baicai_tutor

2. Install dependencies using Poetry:

poetry install

3. Activate the virtual environment:

poetry shell

Usage

The project provides a command-line interface:

baicai-tutor

Development

Project Structure

baicai_tutor/
├── baicai_tutor/    # Main package directory
├── docs/            # Documentation
├── tests/           # Test files
└── pyproject.toml   # Project configuration

Development Tools

• Testing: pytest (>=8.0.0)
• Type Checking: mypy (>=1.5.0)
• Code Formatting: ruff (^0.11.6)
• Documentation: mkdocs (optional)

Running Tests

poetry run pytest

Code Quality

The project uses several tools to maintain code quality:

• Type Checking:

poetry run mypy .

• Code Formatting:

poetry run ruff format .

• Linting:

poetry run ruff check .

Documentation

Documentation is available in the docs/ directory and can be built using MkDocs:

poetry run mkdocs build

Contributing

1. Fork the repository
2. Create a feature branch
3. Commit your changes
4. Push to the branch
5. Create a Pull Request

License

This project is licensed under the GPL-3.0 License.

Authors

• Zhaoyang tech [e-mail]

Acknowledgments

• Built on top of the Baicai Base framework
• Uses various open-source libraries and tools