Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,9 @@ __pycache__
*~
.idea
appmap.yml

# Workshop temporary files
workshops/*/uploads/
workshops/*/results/
workshops/*/venv/
*.pt
58 changes: 58 additions & 0 deletions workshops/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# Python Teaching Workshops

This directory contains comprehensive workshop examples for teaching Python web development with machine learning integration.

## Available Workshops

### 1. Flask + YOLO Object Detection (`flask_yolo_detection/`)

A complete Flask web application demonstrating:
- Web application development with Flask
- File upload handling
- YOLOv8 object detection integration
- Template rendering with Jinja2
- Error handling and validation

**Best for**: Beginners learning Flask and web development basics

### 2. FastAPI + YOLO Object Detection (`fastapi_yolo_detection/`)

A modern REST API built with FastAPI demonstrating:
- Async/await patterns in Python
- RESTful API design
- Automatic API documentation (Swagger/ReDoc)
- Modern frontend-backend communication
- Advanced error handling

**Best for**: Students learning modern API development and async programming

## Getting Started

Each workshop is self-contained with its own:
- README.md with detailed instructions
- requirements.txt with all dependencies
- Complete, working code examples
- Documentation and usage examples

Navigate to the specific workshop directory and follow the README.md instructions to get started.

## Requirements

- Python 3.8 or higher
- pip package manager
- Virtual environment (recommended)

## Workshop Features

Both workshops demonstrate:
- ✅ Real-world application structure
- ✅ Security best practices
- ✅ Clear, commented code
- ✅ Comprehensive documentation
- ✅ Error handling
- ✅ File validation
- ✅ Modern UI design

## Support

For questions or issues with specific workshops, refer to the individual workshop README files.
Loading
Loading