AI-powered educational translation tool for students and teachers
Project description
eduai
A small educational Python package for children and teachers. This repository contains a usable fallback model so the package works immediately without API keys, plus templates you can extend to add OpenAI/Gemini adapters.
What's included
eduai/package with core engine and aFallbackModel(works offline).- Templates for
openai_model.pyandgemini_model.py(not implemented). - CLI:
python -m eduai.cli demo --mode summarize|quiz|explain - Example script:
python examples/demo_run.py pyproject.toml,requirements.txt,LICENSE(MIT)
Quickstart
- (Optional) Create a virtualenv:
python -m venv .venv source .venv/bin/activate
- Install dependencies (optional; fallback works without them):
pip install -r requirements.txt
- Run the demo:
python -m eduai.cli demo --mode summarize python -m eduai.cli demo --mode quiz python -m eduai.cli demo --mode explain
Extending with real models
- Implement
eduai.models.openai_model.OpenAIModeland call it withEduAI(model_name='openai', model_adapter=OpenAIModel(...)). - Implement Gemini adapter in
eduai/models/gemini_model.py.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
eduai-0.1.0.tar.gz
(6.6 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
eduai-0.1.0-py3-none-any.whl
(7.8 kB
view details)
File details
Details for the file eduai-0.1.0.tar.gz.
File metadata
- Download URL: eduai-0.1.0.tar.gz
- Upload date:
- Size: 6.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b7a84724a5d5667c030e8c4b48d5ae5bb167ce3fb081360a3f3f700658c8e0f6
|
|
| MD5 |
1f72c421acdefda57ed898ecc29b1470
|
|
| BLAKE2b-256 |
fceb3851055cbc01ef819a085aad229cace6c27e4b7871c4e4c02f9e9feb25b8
|
File details
Details for the file eduai-0.1.0-py3-none-any.whl.
File metadata
- Download URL: eduai-0.1.0-py3-none-any.whl
- Upload date:
- Size: 7.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9c8ae79c2792d02ae30fc72d21f237d3365f06199c8e61e73af15925acc0b7b6
|
|
| MD5 |
b3352da00f65599981fb220dabd8d3fd
|
|
| BLAKE2b-256 |
044595d6227bfc9cbf2f367b0a69bef2dadcb0fd39fbd8034e860cee2f575681
|