Skip to content

Commit 267fdf3

Browse files
committed
Update 0.2.4
1 parent c8e7366 commit 267fdf3

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+3022
-372
lines changed

.devcontainer/OVERVIEW.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ A complete containerized development environment for YokedCache with Redis, Memc
8383
## 🌐 Service URLs
8484

8585
- **Redis**: `redis://redis:56379`
86-
- **Memcached**: `memcached:51211`
86+
- **Memcached**: `memcached:11211`
8787
- **Redis Insight**: <http://localhost:58001>
8888
- **Prometheus**: <http://localhost:59090>
8989
- **Grafana**: <http://localhost:53000> (admin/admin)
@@ -111,14 +111,14 @@ graph TB
111111
A --> C[Redis 7]
112112
A --> D[Memcached]
113113
A --> E[Development Tools]
114-
114+
115115
B --> F[YokedCache Source]
116116
B --> G[All Dependencies]
117117
B --> H[Testing Framework]
118-
118+
119119
C --> I[Cache Backend]
120120
D --> J[Alternative Backend]
121-
121+
122122
E --> K[Code Quality Tools]
123123
E --> L[Documentation Tools]
124124
E --> M[Monitoring Stack]
@@ -193,7 +193,7 @@ Access dashboards:
193193
## 🎯 Development Best Practices
194194

195195
1. **Use the helper script**: `./dev.sh` for common tasks
196-
2. **Run tests frequently**: `./dev.sh test`
196+
2. **Run tests frequently**: `./dev.sh test`
197197
3. **Format before committing**: `./dev.sh format`
198198
4. **Check code quality**: `./dev.sh quality`
199199
5. **Monitor cache health**: `./dev.sh ping` and `./dev.sh stats`

.devcontainer/PORT-UPDATE-SUMMARY.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ All service ports have been changed to non-standard values to avoid conflicts wi
99
| Service | Old Port | New Port | Description |
1010
|---------|----------|----------|-------------|
1111
| Redis | 6379 | **56379** | Main Redis cache service |
12-
| Memcached | 11211 | **51211** | Alternative cache backend |
12+
| Memcached | 11211 | **11211** | Alternative cache backend |
1313
| Redis Insight | 8001 | **58001** | Redis GUI interface |
1414
| Prometheus | 9090 | **59090** | Metrics collection |
1515
| Grafana | 3000 | **53000** | Metrics visualization |
@@ -19,15 +19,15 @@ All service ports have been changed to non-standard values to avoid conflicts wi
1919

2020
### Updated Files
2121

22-
**devcontainer.json** - Port forwarding and environment variables
23-
**docker-compose.yml** - Service port mappings and health checks
24-
**redis.conf** - Redis server port configuration
25-
**prometheus.yml** - Scrape target endpoints
26-
**post-create.sh** - Connection tests and config generation
27-
**dev.sh** - Helper script commands
28-
**README.md** - Documentation updates
29-
**OVERVIEW.md** - Service URL references
30-
**Dockerfile** - Exposed ports
22+
**devcontainer.json** - Port forwarding and environment variables
23+
**docker-compose.yml** - Service port mappings and health checks
24+
**redis.conf** - Redis server port configuration
25+
**prometheus.yml** - Scrape target endpoints
26+
**post-create.sh** - Connection tests and config generation
27+
**dev.sh** - Helper script commands
28+
**README.md** - Documentation updates
29+
**OVERVIEW.md** - Service URL references
30+
**Dockerfile** - Exposed ports
3131

3232
### Environment Variables
3333

@@ -40,7 +40,7 @@ YOKEDCACHE_PROMETHEUS_PORT=58000
4040
### Service URLs (Updated)
4141

4242
- **Redis**: `redis://redis:56379`
43-
- **Memcached**: `memcached:51211`
43+
- **Memcached**: `memcached:11211`
4444
- **Redis Insight**: http://localhost:58001
4545
- **Prometheus**: http://localhost:59090
4646
- **Grafana**: http://localhost:53000 (admin/admin)
@@ -54,7 +54,7 @@ YOKEDCACHE_PROMETHEUS_PORT=58000
5454
redis-cli -h redis -p 56379
5555

5656
# Test memcached
57-
nc -z memcached 51211
57+
nc -z memcached 11211
5858

5959
# Documentation server
6060
mkdocs serve --dev-addr=0.0.0.0:58080

.devcontainer/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This directory contains a complete containerized development environment for Yok
44

55
## 🚀 Quick Start
66

7-
1. **Prerequisites**:
7+
1. **Prerequisites**:
88
- Install [Docker Desktop](https://www.docker.com/products/docker-desktop/)
99
- Install [VS Code](https://code.visualstudio.com/)
1010
- Install the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
@@ -32,7 +32,7 @@ This directory contains a complete containerized development environment for Yok
3232

3333
### Optional Monitoring Stack
3434
- **Redis Insight** (GUI for Redis) - Port 8001
35-
- **Prometheus** (Metrics collection) - Port 9090
35+
- **Prometheus** (Metrics collection) - Port 9090
3636
- **Grafana** (Metrics visualization) - Port 3000
3737

3838
## 🔧 Configuration
@@ -51,7 +51,7 @@ PYTHONPATH=/workspace/src
5151

5252
### Service URLs
5353
- **Redis**: `redis://redis:56379`
54-
- **Memcached**: `memcached:51211`
54+
- **Memcached**: `memcached:11211`
5555
- **Redis Insight**: http://localhost:58001
5656
- **Prometheus**: http://localhost:59090
5757
- **Grafana**: http://localhost:53000 (admin/admin)

.devcontainer/dev.sh

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ case "$1" in
4545
pip install -e .
4646
log_success "Development installation complete"
4747
;;
48-
48+
4949
"test"|"tests")
5050
log_info "Running tests..."
5151
activate_env
@@ -55,30 +55,30 @@ case "$1" in
5555
pytest -v
5656
fi
5757
;;
58-
58+
5959
"test-cov"|"coverage")
6060
log_info "Running tests with coverage..."
6161
activate_env
6262
pytest --cov=yokedcache --cov-report=html --cov-report=term-missing
6363
log_success "Coverage report generated in htmlcov/"
6464
;;
65-
65+
6666
"format"|"fmt")
6767
log_info "Formatting code..."
6868
activate_env
6969
black src tests
7070
isort src tests
7171
log_success "Code formatting complete"
7272
;;
73-
73+
7474
"lint")
7575
log_info "Running linting checks..."
7676
activate_env
7777
flake8 src tests
7878
mypy src
7979
log_success "Linting complete"
8080
;;
81-
81+
8282
"quality"|"qa")
8383
log_info "Running all quality checks..."
8484
activate_env
@@ -88,82 +88,82 @@ case "$1" in
8888
mypy src
8989
log_success "All quality checks passed"
9090
;;
91-
91+
9292
"docs"|"doc")
9393
log_info "Building documentation..."
9494
activate_env
9595
mkdocs build
9696
log_success "Documentation built in site/"
9797
;;
98-
98+
9999
"docs-serve")
100100
log_info "Starting documentation server..."
101101
activate_env
102102
mkdocs serve --dev-addr=0.0.0.0:58080
103103
;;
104-
104+
105105
"redis-cli")
106106
log_info "Connecting to Redis CLI..."
107107
redis-cli -h redis -p 56379
108108
;;
109-
109+
110110
"ping")
111111
log_info "Testing cache connection..."
112112
activate_env
113113
yokedcache ping
114114
;;
115-
115+
116116
"stats")
117117
log_info "Showing cache statistics..."
118118
activate_env
119119
yokedcache stats
120120
;;
121-
121+
122122
"clear")
123123
log_warning "Clearing cache..."
124124
activate_env
125125
yokedcache clear --confirm
126126
log_success "Cache cleared"
127127
;;
128-
128+
129129
"logs")
130130
service="${2:-yokedcache-dev}"
131131
log_info "Showing logs for $service..."
132132
docker logs -f "$service"
133133
;;
134-
134+
135135
"shell")
136136
log_info "Starting development shell..."
137137
activate_env
138138
exec bash
139139
;;
140-
140+
141141
"jupyter")
142142
log_info "Starting Jupyter Lab..."
143143
activate_env
144144
jupyter lab --ip=0.0.0.0 --port=58888 --allow-root --no-browser
145145
;;
146-
146+
147147
"monitor")
148148
log_info "Starting monitoring stack..."
149149
docker-compose --profile monitoring up -d
150150
log_success "Monitoring stack started:"
151151
log_info " • Prometheus: http://localhost:59090"
152152
log_info " • Grafana: http://localhost:53000 (admin/admin)"
153153
;;
154-
154+
155155
"tools")
156156
log_info "Starting development tools..."
157157
docker-compose --profile tools up -d
158158
log_success "Tools started:"
159159
log_info " • Redis Insight: http://localhost:58001"
160160
;;
161-
161+
162162
"status")
163163
log_info "Service status:"
164164
docker-compose ps
165165
;;
166-
166+
167167
"restart")
168168
service="${2:-all}"
169169
if [ "$service" = "all" ]; then
@@ -175,14 +175,14 @@ case "$1" in
175175
fi
176176
log_success "Restart complete"
177177
;;
178-
178+
179179
"clean")
180180
log_info "Cleaning up development environment..."
181181
docker-compose down -v
182182
docker system prune -f
183183
log_success "Cleanup complete"
184184
;;
185-
185+
186186
"help"|""|"-h"|"--help")
187187
echo "YokedCache Development Helper"
188188
echo ""
@@ -221,7 +221,7 @@ case "$1" in
221221
echo " jupyter Start Jupyter Lab"
222222
echo ""
223223
;;
224-
224+
225225
*)
226226
log_error "Unknown command: $1"
227227
echo "Run './dev.sh help' for available commands"

0 commit comments

Comments
 (0)