📚 Looking to learn design patterns in Python? Explore our docs and lessons to study and apply design patterns through clear, hands-on examples — perfect for self-paced learning or AI-assisted coding!

This repository helps you:

1. Learn software design patterns in Python with clean, structured examples.
2. Use those lessons with LLMs like ChatGPT, Open WebUI, or Ollama for Retrieval-Augmented Generation (RAG) coding workflows.
3. Leverage preprocessed pattern chunks and a searchable index to integrate design knowledge directly into AI tooling.

Visit our website or the docs/ directory to find:

• Lesson plans and code walkthroughs for each pattern.
• Example-driven explanations optimized for learning and memory.
• Markdown-formatted versions ideal for study or RAG ingestion.

If you want to integrate pattern knowledge into AI tools:

• Use the chunks/ directory: preprocessed, docstring-enhanced Markdown files.
• Reference summary_index.json: a machine-readable index with metadata and summaries.

These resources are ready to drop into Open WebUI, Ollama, or any system that supports knowledge base ingestion.

• Open the "Knowledge" tab in WebUI.
• Create a new base using the chunks/ folder.

Use your RAG-enabled system to ask:

How do I implement the Builder pattern in Python?
What's the difference between Singleton and Borg?
Show me a working example of the Strategy pattern.

Use summary_index.json to:

• Power UI navigation
• Search by pattern
• Generate dynamic summaries

python-design-pattern-rag/
├── chunks/              # RAG-optimized pattern files (Markdown)
├── docs/                # Educational lessons and explanations
├── patterns/            # Raw Python implementations of each pattern
├── ollama/              # Ollama-specific configuration (for development)
├── scripts/             # Scripts for building Docs and RAG files (for development)
├── CONTRIBUTING.md      # Instructions and Guidelines for contributing
├── LICENSE              # License information
├── README.md            # Project overview and instructions
├── requirements.txt     # Project dependencies (for development)
├── summary_index.json   # Index of all patterns and their RAG files
└── tasks.py             # Tasks for building the project

If you’d like to build, extend, or contribute to this project, check out our Developer Guide for setup instructions and contribution tips.

This project was created and maintained by Matthew Craig (TaggedZi) with assistance from OpenAI's ChatGPT (powered by GPT-4). Contributions from the various AIs included scaffolding, documentation, and refinement recommendations.

This project also relies on:

• Ollama
• Falcon 3 by TII
• DeepSeek Coder by DeepSeek

This project is licensed under the MIT License. See LICENSE for details.