Skip to content

Commit ba4becb

Browse files
DOC-5851 moved code proj folder to local_examples
1 parent 8bbc059 commit ba4becb

19 files changed

+2421
-28
lines changed

local_examples/use-cases/cache-aside/IMPLEMENTATION_SUMMARY.md

Lines changed: 418 additions & 0 deletions
Large diffs are not rendered by default.

content/develop/use-cases/cache-aside/README.md renamed to local_examples/use-cases/cache-aside/README.md

Lines changed: 54 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,3 @@
1-
---
2-
title: Cache-Aside Pattern Tutorial Specifications
3-
description: Complete specifications for implementing cache-aside pattern tutorials with Redis
4-
categories:
5-
- docs
6-
- develop
7-
- use-cases
8-
---
9-
101
# Cache-Aside Pattern Tutorial Specifications
112

123
This directory contains comprehensive specifications for implementing cache-aside pattern tutorials with Redis.
@@ -25,6 +16,8 @@ This directory contains comprehensive specifications for implementing cache-asid
2516

2617
Complete blueprint for the cache-aside pattern tutorial, including:
2718

19+
Complete blueprint for the cache-aside pattern tutorial, including:
20+
2821
- **Tutorial Objectives** - 6 learning outcomes
2922
- **Conceptual Overview** - Pattern definition, flow diagram, comparison with other patterns
3023
- **Implementation Guide** - 5 steps with pseudocode:
@@ -60,12 +53,13 @@ Complete blueprint for the cache-aside pattern tutorial, including:
6053

6154
---
6255

63-
### 3. `cache-aside-python-specification.md`
64-
**Python implementation & test specification** (~1,350 lines)
56+
### 3. `python/` Directory
57+
**Complete Python implementation** with specification, code, and tests
6558

59+
#### `python/SPECIFICATION.md` (~1,350 lines)
6660
Complete Python-specific guide, split into two parts:
6761

68-
#### Part 1: Implementation Specification (Sections 1-11)
62+
**Part 1: Implementation Specification (Sections 1-11)**
6963
- Dependencies and setup
7064
- Redis connection configuration
7165
- Mock data source
@@ -98,11 +92,36 @@ Complete Python-specific guide, split into two parts:
9892
- CI/CD integration (GitHub Actions example)
9993
- Test maintenance guidelines
10094

95+
#### Python Implementation Files
96+
97+
**Core Implementation:**
98+
- `cache_config.py` - Configuration class (CacheConfig)
99+
- `cache_manager.py` - Cache managers (CacheAsideManager, AsyncCacheAsideManager)
100+
- `cache_aside.py` - Utility functions (346 lines, 20+ functions)
101+
- `mock_data_store.py` - Mock data source for testing
102+
103+
**Examples:**
104+
- `cache_aside_example.py` - Complete working example with 6 scenarios
105+
106+
**Tests (52+ test cases):**
107+
- `conftest.py` - Pytest fixtures and configuration
108+
- `test_cache_manager.py` - 18 unit tests for cache manager
109+
- `test_cache_aside.py` - 14 unit tests for utility functions
110+
- `test_integration.py` - 9 integration tests with real Redis
111+
- `test_async.py` - 11 async tests
112+
113+
**Configuration:**
114+
- `requirements.txt` - Core dependencies
115+
- `requirements-test.txt` - Test dependencies
116+
- `pytest.ini` - Pytest configuration
117+
- `README.md` - Python tutorial guide
118+
101119
**Use this for:**
102120
- Implementing Python cache-aside tutorials
103121
- Writing comprehensive tests
104122
- Understanding async patterns
105123
- Setting up CI/CD pipelines
124+
- Running working examples
106125

107126
---
108127

@@ -115,17 +134,17 @@ Complete Python-specific guide, split into two parts:
115134

116135
### For Implementing in Python
117136
1. Read `cache-aside-specification.md` section 3 (implementation guide)
118-
2. Study `cache-aside-python-specification.md` Part 1 (implementation)
119-
3. Review `cache-aside-python-specification.md` Part 2 (tests)
120-
4. Implement following the specifications
137+
2. Study `python/SPECIFICATION.md` Part 1 (implementation)
138+
3. Review `python/SPECIFICATION.md` Part 2 (tests)
139+
4. Implement following the specifications in the `python/` directory
121140

122141
### For Troubleshooting
123142
1. Read `cache-aside-specification.md` section 7 (troubleshooting)
124143
2. Check section 4 (common pitfalls)
125144
3. Review error handling in Python spec
126145

127146
### For Async/Modern Python
128-
1. Read `cache-aside-python-specification.md` section 10 (async patterns)
147+
1. Read `python/SPECIFICATION.md` section 10 (async patterns)
129148
2. Review FastAPI integration example
130149
3. Check async tests (section 12)
131150

@@ -137,7 +156,8 @@ Complete Python-specific guide, split into two parts:
137156
|----------|-------|----------|----------------|-----------|
138157
| Main Spec | 1,100 | 8 | 15+ | N/A |
139158
| Python Spec | 1,350 | 16 | 50+ | 35+ |
140-
| **Total** | **2,450** | **24** | **65+** | **35+** |
159+
| Python Implementation | ~500 | N/A | 100% | 35+ |
160+
| **Total** | **2,950+** | **24** | **65+** | **35+** |
141161

142162
---
143163

@@ -243,8 +263,23 @@ Complete Python-specific guide, split into two parts:
243263
cache-aside/
244264
├── cache-aside-tutorial-overview.md ........... Original source material
245265
├── cache-aside-specification.md .............. Language-neutral spec (1,100 lines)
246-
├── cache-aside-python-specification.md ....... Python spec (1,350 lines)
247-
└── README.md ................................ This file
266+
├── README.md ................................ This file
267+
└── python/
268+
├── SPECIFICATION.md ....................... Python spec (1,350 lines)
269+
├── cache_config.py ........................ Configuration class
270+
├── mock_data_store.py ..................... Mock data source
271+
├── cache_manager.py ....................... Cache manager classes
272+
├── cache_aside.py ......................... Utility functions
273+
├── cache_aside_example.py ................. Complete example
274+
├── requirements.txt ....................... Dependencies
275+
├── requirements-test.txt .................. Test dependencies
276+
├── pytest.ini ............................. Pytest configuration
277+
├── conftest.py ............................ Test fixtures
278+
├── test_cache_manager.py .................. Unit tests
279+
├── test_cache_aside.py .................... Utility function tests
280+
├── test_integration.py .................... Integration tests
281+
├── test_async.py .......................... Async tests
282+
└── README.md ............................. Python tutorial guide
248283
```
249284

250285
---

content/develop/use-cases/cache-aside/cache-aside-specification.md renamed to local_examples/use-cases/cache-aside/cache-aside-specification.md

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,3 @@
1-
---
2-
title: Cache-Aside Pattern Tutorial Specification
3-
description: Comprehensive language-neutral specification for the cache-aside pattern tutorial
4-
categories:
5-
- docs
6-
- develop
7-
- use-cases
8-
---
9-
101
# Cache-Aside Pattern Tutorial Specification
112

123
**Document Type:** Language-Neutral Specification
File renamed without changes.

0 commit comments

Comments
 (0)