{"id":28105389,"url":"https://github.com/taggedzi/python-design-pattern-rag","last_synced_at":"2025-10-07T02:50:18.812Z","repository":{"id":291768901,"uuid":"978706475","full_name":"taggedzi/python-design-pattern-rag","owner":"taggedzi","description":"A collection of python design pattern examples and documentation. Also converted into Markdown format and setup for easy RAG consumption.","archived":false,"fork":false,"pushed_at":"2025-05-13T20:17:05.000Z","size":236,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-13T21:31:44.833Z","etag":null,"topics":["ai-assisted-coding","code-examples","design-patterns","documentation","education","educational","examples","learning-resources","lesson-plans","llm-integration","object-oriented-programming","open-webui","patterns","python","python-3","python-patterns","python3","rag","retrieval-augmented-generation","software-architecture"],"latest_commit_sha":null,"homepage":"https://taggedzi.github.io/python-design-pattern-rag/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/taggedzi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-05-06T11:48:30.000Z","updated_at":"2025-05-13T20:17:09.000Z","dependencies_parsed_at":"2025-05-13T21:29:01.025Z","dependency_job_id":null,"html_url":"https://github.com/taggedzi/python-design-pattern-rag","commit_stats":null,"previous_names":["taggedzi/python-design-pattern-rag"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taggedzi%2Fpython-design-pattern-rag","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taggedzi%2Fpython-design-pattern-rag/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taggedzi%2Fpython-design-pattern-rag/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taggedzi%2Fpython-design-pattern-rag/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/taggedzi","download_url":"https://codeload.github.com/taggedzi/python-design-pattern-rag/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254036843,"owners_count":22003654,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai-assisted-coding","code-examples","design-patterns","documentation","education","educational","examples","learning-resources","lesson-plans","llm-integration","object-oriented-programming","open-webui","patterns","python","python-3","python-patterns","python3","rag","retrieval-augmented-generation","software-architecture"],"created_at":"2025-05-13T22:17:56.765Z","updated_at":"2025-10-07T02:50:13.781Z","avatar_url":"https://github.com/taggedzi.png","language":"Python","readme":"# 🧠 Python Design Patterns — Learn \u0026 Use with AI\n\n![Made for RAG](https://img.shields.io/badge/RAG-Ready-blueviolet)\n![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue)\n![Powered by Ollama](https://img.shields.io/badge/Ollama-Compatible-blue)\n![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)\n![Built with ❤️ by TaggedZi](https://img.shields.io/badge/built%20with-%E2%9D%A4%EF%B8%8F%20by%20TaggedZi-orange)\n\n\u003e 📚 **Looking to learn design patterns in Python?**\n\u003e Explore our [docs and lessons](https://taggedzi.github.io/python-design-pattern-rag/) to study and apply design patterns through clear, hands-on examples — perfect for self-paced learning or AI-assisted coding!\n\n---\n\n## 📌 What This Project Does\n\nThis repository helps you:\n\n1. **Learn software design patterns in Python** with clean, structured examples.\n2. **Use those lessons with LLMs** like ChatGPT, Open WebUI, or Ollama for **Retrieval-Augmented Generation (RAG)** coding workflows.\n3. **Leverage preprocessed pattern chunks** and a searchable index to integrate design knowledge directly into AI tooling.\n\n---\n\n## 🏫 Educational Lessons \u0026 Docs\n\nVisit our [website](https://taggedzi.github.io/python-design-pattern-rag/) or the [`docs/`](docs/) directory to find:\n\n* Lesson plans and code walkthroughs for each pattern.\n* Example-driven explanations optimized for learning and memory.\n* Markdown-formatted versions ideal for study or RAG ingestion.\n\n---\n\n## 🔄 RAG-Optimized Content\n\nIf you want to integrate pattern knowledge into AI tools:\n\n* Use the `chunks/` directory: preprocessed, docstring-enhanced Markdown files.\n* Reference `summary_index.json`: a machine-readable index with metadata and summaries.\n\nThese resources are **ready to drop into Open WebUI, Ollama**, or any system that supports knowledge base ingestion.\n\n---\n\n## 🛠 How to Use with Open WebUI + Ollama\n\n### 1. Add to a Knowledge Base\n\n* Open the **\"Knowledge\"** tab in WebUI.\n* Create a new base using the `chunks/` folder.\n\n### 2. Ask Contextual Questions\n\nUse your RAG-enabled system to ask:\n\n```text\nHow do I implement the Builder pattern in Python?\nWhat's the difference between Singleton and Borg?\nShow me a working example of the Strategy pattern.\n```\n\n### 3. Use the Index\n\nUse `summary_index.json` to:\n\n* Power UI navigation\n* Search by pattern\n* Generate dynamic summaries\n\n---\n\n## 📁 Project Structure\n\n```text\npython-design-pattern-rag/\n├── chunks/              # RAG-optimized pattern files (Markdown)\n├── docs/                # Educational lessons and explanations\n├── patterns/            # Raw Python implementations of each pattern\n├── ollama/              # Ollama-specific configuration (for development)\n├── scripts/             # Scripts for building Docs and RAG files (for development)\n├── CONTRIBUTING.md      # Instructions and Guidelines for contributing\n├── LICENSE              # License information\n├── README.md            # Project overview and instructions\n├── requirements.txt     # Project dependencies (for development)\n├── summary_index.json   # Index of all patterns and their RAG files\n└── tasks.py             # Tasks for building the project\n```\n\n---\n\n### 👩‍💻 Developers \u0026 Contributors\n\nIf you’d like to build, extend, or contribute to this project, check out our [Developer Guide](CONTRIBUTING.md) for setup instructions and contribution tips.\n\n---\n\n### 🙏 Acknowledgments\n\nThis 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.\n\nThis project also relies on:\n\n* [Ollama](https://ollama.com)\n* [Falcon 3](https://ollama.com/library/falcon3) by TII\n* [DeepSeek Coder](https://ollama.com/library/deepseek-coder) by DeepSeek\n  \n---\n\n### 📄 License\n\nThis project is licensed under the **MIT License**. See [LICENSE](./LICENSE) for details.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftaggedzi%2Fpython-design-pattern-rag","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftaggedzi%2Fpython-design-pattern-rag","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftaggedzi%2Fpython-design-pattern-rag/lists"}