Hands-on AI Toolkit for classrooms
Project description
HandsOnAI: Your AI Learning Lab
AI learning made simple for students and educators
HandsOnAI is a unified educational toolkit designed to teach students how modern AI systems work — by building and interacting with them directly.
It provides a clean, modular structure that introduces core AI concepts progressively through three tools:
🧱 Module Overview
| Module | Purpose | CLI Name |
|---|---|---|
| chat | Simple chatbot with system prompts | chat |
| rag | Retrieval-Augmented Generation (RAG) | rag |
| agent | ReAct-style reasoning with tool use | agent |
Each module is:
- 🔌 Self-contained
- 🧩 Installable via one package:
pip install hands-on-ai - 🧠 Designed for progressive learning
🗂 Project Structure
hands_on_ai/
├── chat/ ← A simple prompt/response chatbot
├── rag/ ← Ask questions using your own documents
├── agent/ ← Agent reasoning + tools (ReAct-style)
├── config.py ← Shared config (model, chunk size, paths)
├── cli.py ← Meta CLI (list, config, version)
└── utils/ ← Shared tools, prompts, paths, etc.
🧑🏫 Why This Matters for Students
Each tool teaches a different level of modern AI interaction:
- chat – Prompt engineering, roles, and LLMs
- rag – Document search, embeddings, and grounded answers
- agent – Multi-step reasoning, tool use, and planning
🚀 Getting Started
Installation
# Install from PyPI
pip install hands-on-ai
# Or directly from GitHub
pip install git+https://github.com/teaching-repositories/hands-on-ai.git
Prerequisites
- Python 3.6 or higher
- For local LLM usage: Ollama or similar local LLM server
Quick Start
Run a local Ollama server, then import and start chatting:
from hands_on_ai.chat import pirate_bot
print(pirate_bot("What is photosynthesis?"))
For more options:
from hands_on_ai.chat import get_response, friendly_bot, pirate_bot
# Basic usage with default model
response = get_response("Tell me about planets")
print(response)
# Use a personality bot
pirate_response = pirate_bot("Tell me about sailing ships")
print(pirate_response)
Contributing
We welcome contributions! See CONTRIBUTING.md for guidelines on how to get involved.
License
This project is licensed under the MIT License - see the LICENSE file for details.
Acknowledgments
- Built with education in mind
- Powered by open-source LLM technology
- Inspired by educators who want to bring AI into the classroom responsibly
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 Distributions
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
File details
Details for the file hands_on_ai-0.1.0-py3-none-any.whl.
File metadata
- Download URL: hands_on_ai-0.1.0-py3-none-any.whl
- Upload date:
- Size: 131.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.0.1 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cb53a331087fe32b4c22d33edee99118d18366cef85f8fb1df2a2be5676a0928
|
|
| MD5 |
0cd24937cd456c156f8bda2337caff1c
|
|
| BLAKE2b-256 |
19bd0bf9999701cb9eb91015c10e0d3ed6cbe8a51e40884d4c712ca7c005d25a
|