Skip to main content

Hands-on AI Toolkit for classrooms

Project description

HandsOnAI: Your AI Learning Lab

Python 3.6+ MIT License Classroom Ready Beginner Friendly

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.

🔐 API Key Configuration

Environment Variable Method

# Set API key in your environment
export HANDS_ON_AI_API_KEY=your_secret_api_key_here

In-Code Configuration

from hands_on_ai import setup_colab

# Configure with API key
setup_colab(
    server_url="https://your-ollama-server.com",
    model="llama2",
    api_key="your_secret_api_key_here"
)

Secure API Key Management

# Verify API key configuration
from hands_on_ai.config import get_api_key

api_key = get_api_key()
if api_key:
    print("API key is configured successfully")
else:
    print("No API key found. Please configure.")

🧱 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

🚀 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

Quick Start

from hands_on_ai.chat import get_response

# Basic usage with API key
response = get_response("Hello, how are you?")
print(response)

🛡️ Security Best Practices

  • Never hardcode API keys in source code
  • Use environment variables
  • Rotate API keys periodically
  • Use secure configuration management

📚 Documentation

🤝 Contributing

We welcome contributions! See CONTRIBUTING.md for guidelines.

📄 License

MIT License - see LICENSE for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hands_on_ai-0.1.6.tar.gz (110.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

hands_on_ai-0.1.6-py3-none-any.whl (132.5 kB view details)

Uploaded Python 3

File details

Details for the file hands_on_ai-0.1.6.tar.gz.

File metadata

  • Download URL: hands_on_ai-0.1.6.tar.gz
  • Upload date:
  • Size: 110.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.17

File hashes

Hashes for hands_on_ai-0.1.6.tar.gz
Algorithm Hash digest
SHA256 e877cf7d70d55e78145d86f311abd4f9f3efba2934967e98c09fa8e5c784e42d
MD5 5cd33ca851fbe6ee9ba9e3a8cc5456a6
BLAKE2b-256 d24a95b5a9b12e2d0fbc61a64ce1e4fe35c5beb033657a5382ded5edcdee3bf1

See more details on using hashes here.

File details

Details for the file hands_on_ai-0.1.6-py3-none-any.whl.

File metadata

File hashes

Hashes for hands_on_ai-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 1c6f5ab2deca08c37687af7b569bd9ecb0f99c3a749b59cd761aecb9c4030472
MD5 7cc78425e51c7463376b1d8881c42855
BLAKE2b-256 8bc18b78a7e1fc3f729afb684b0bafa14ff1422ecd54d8f808de9f2e85238914

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page