Skip to content

Commit 2f616fb

Browse files
docs(readme): add architectural overview, Mermaid diagram, and badges
1 parent 5283e22 commit 2f616fb

1 file changed

Lines changed: 61 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,47 @@
11
# 🐍 Python Learning Assistant
22

3+
> **Author & Architect:** [Robina Mirbahar](https://github.com/RobinaMirbahar) (Google Developer Expert in Cloud & AI)
4+
> **Focus:** Interactive AI-Powered Python Tutor (Variables to Metaclasses & 50+ Hands-On Exercises) with Streamlit & Google Gemini
5+
6+
---
7+
8+
## 🎯 Why I Built Python Learning Assistant (Engineering Purpose & Real-World Value)
9+
10+
### 1. 🐍 Personalized Socratic Mentorship Over Copy-Paste Answers
11+
I built the Python Learning Assistant to guide learners from foundational syntax (`variables`, `loops`) to advanced software engineering (`decorators`, `generators`, `metaclasses`) using adaptive Socratic hints rather than just dumping solutions.
12+
13+
### 2. 🧪 50+ Structured Coding Challenges with Live Feedback
14+
I curated more than 50 progressive exercises where the Gemini-powered evaluator inspects AST structure, edge cases, and PEP 8 style in real time.
15+
16+
### 3. 🌱 Accessible Browser-First Learning Environment
17+
By packaging the tutor in a clean Streamlit interface, students and workshop attendees can practice Python interactively from any laptop or tablet.
18+
19+
---
20+
21+
## 🏗️ System Architecture
22+
23+
```mermaid
24+
flowchart TD
25+
subgraph UI ["1. Interactive Streamlit Learning Portal"]
26+
U_Mod["Curriculum Selector (Basics ➔ OOP ➔ Metaclasses)"]
27+
U_Code["Interactive Code Editor & 50+ Exercises"]
28+
U_Chat["Socratic AI Mentor Q&A"]
29+
end
30+
subgraph Tutor ["2. Gemini Pedagogical Evaluation Engine"]
31+
T_Check["Code Correctness & Edge-Case Grader"]
32+
T_Hint["Adaptive Hint & Concept Visualizer"]
33+
T_PEP["PEP 8 Idiomatic Style Coach"]
34+
end
35+
subgraph Progress ["3. Learner Mastery Tracking"]
36+
P_State["Session Progress & Skill Badges"]
37+
end
38+
U_Mod --> U_Code --> T_Check
39+
U_Chat --> T_Hint
40+
T_Check --> T_Hint & T_PEP --> P_State
41+
```
42+
43+
---
44+
345
<div align="center">
446

547
[![Streamlit App](https://static.streamlit.io/badges/streamlit_badge_black_white.svg)](https://python-learning-assistant.streamlit.app/)
@@ -185,3 +227,22 @@ Distributed under the **MIT License**. See [`LICENSE`](LICENSE) for details.
185227
<div align="center">
186228
<img src="https://raw.githubusercontent.com/RobinaMirbahar/RobinaMirbahar/main/ProfileImages/GithubBanner.svg" alt="Robina Mirbahar Banner" width="100%" />
187229
</div>
230+
231+
<!-- AUTHOR_SIGNATURE_START -->
232+
---
233+
234+
## 👩‍💻 About the Author
235+
236+
**Robina Mirbahar — Google Cloud & AI Architect**
237+
*Google Developer Expert (GDE) in Cloud & AI • Published Author • Multi-Agent Systems & Serverless GPU Builder*
238+
239+
[![GitHub](https://img.shields.io/badge/GitHub-RobinaMirbahar-181717?style=for-the-badge&logo=github)](https://github.com/RobinaMirbahar)
240+
[![Medium](https://img.shields.io/badge/Medium-@robinamirbahar-000000?style=for-the-badge&logo=medium)](https://medium.com/@robinamirbahar)
241+
[![DEV.to](https://img.shields.io/badge/DEV.to-robinamirbahar-0A0A0A?style=for-the-badge&logo=devdotto)](https://dev.to/robinamirbahar)
242+
[![LinkedIn](https://img.shields.io/badge/LinkedIn-Robina_Mirbahar-0A66C2?style=for-the-badge&logo=linkedin)](https://www.linkedin.com/in/robina-mirbahar)
243+
[![GDE Profile](https://img.shields.io/badge/Google_Developer_Expert-Profile-4285F4?style=for-the-badge&logo=google)](https://g.dev/RobinaMirbahar)
244+
[![YouTube](https://img.shields.io/badge/YouTube-@RobinaMirbahar-FF0000?style=for-the-badge&logo=youtube)](https://www.youtube.com/@RobinaMirbahar)
245+
[![X](https://img.shields.io/badge/X-@RobinaMirbahar-000000?style=for-the-badge&logo=x)](https://x.com/RobinaMirbahar)
246+
[![Amazon Author](https://img.shields.io/badge/Amazon_Book-Cloud_Computing_Voyage-FF9900?style=for-the-badge&logo=amazon)](https://www.amazon.com/dp/B0D146249R)
247+
248+
<!-- AUTHOR_SIGNATURE_END -->

0 commit comments

Comments
 (0)