Skip to content

Commit cb3bfc6

Browse files
author
Yasser Toruno
committed
remove references to install valkey from docs
1 parent 07827c3 commit cb3bfc6

3 files changed

Lines changed: 1 addition & 64 deletions

File tree

README.md

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -240,9 +240,6 @@ source venv/bin/activate # On Windows: venv\Scripts\activate
240240
# Install base package and development dependencies
241241
make install
242242

243-
# Or with Valkey support
244-
INSTALL_VALKEY=true make install
245-
246243
# Or manually
247244
pip install -e .
248245
pip install -r requirements.txt
@@ -254,9 +251,6 @@ pip install -r requirements.txt
254251
# Default setup with Python 3.10
255252
make docker_up
256253

257-
# Or with Valkey support
258-
INSTALL_VALKEY=true make docker_up
259-
260254
# Or with different Python version
261255
PYTHON_VERSION=3.11 make docker_up
262256

@@ -265,7 +259,6 @@ make docker_shell
265259
```
266260

267261
**Environment Variables:**
268-
- `INSTALL_VALKEY=true` - Install and enable optional Valkey support
269262
- `PYTHON_VERSION=3.11` - Use specific Python version for Docker (default: 3.10)
270263

271264
### 3. Set Up Example Project
@@ -305,14 +298,11 @@ by invoking pytest directly:
305298
# Test in Docker container
306299
make test_docker
307300

308-
# Test with Valkey support enabled
309-
INSTALL_VALKEY=true make test_docker
310-
311301
# Test with specific Python version
312302
PYTHON_VERSION=3.11 make test_docker
313303

314304
# Test without Docker (requires redis, valkey, memcached services running)
315305
make test_local
316306
```
317307

318-
**Note:** When `INSTALL_VALKEY=true` is set, the docker image will include optional Valkey support automatically.
308+
**Note:** When using python 3.10 or greater, valkey support will be enabled.

docs/development.md

Lines changed: 0 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -27,16 +27,9 @@ make docker_up # Start all services
2727
make docker_shell # Open shell in container
2828
```
2929

30-
**With Valkey Support:**
31-
```bash
32-
INSTALL_VALKEY=true make docker_up
33-
INSTALL_VALKEY=true make docker_shell
34-
```
35-
3630
**With Different Python Version:**
3731
```bash
3832
PYTHON_VERSION=3.11 make docker_up
39-
PYTHON_VERSION=3.11 INSTALL_VALKEY=true make docker_up
4033
```
4134

4235
Services included:
@@ -56,10 +49,6 @@ source venv/bin/activate # Windows: venv\Scripts\activate
5649
# Install package and dependencies
5750
make install
5851

59-
# Or with Valkey support
60-
INSTALL_VALKEY=true make install
61-
```
62-
6352
Alternative manual installation:
6453
```bash
6554
pip install -e .
@@ -109,26 +98,12 @@ make test_docker
10998
make test_local
11099
```
111100

112-
### Testing with Valkey Support
113-
114-
```bash
115-
# Docker with Valkey
116-
INSTALL_VALKEY=true make test_docker
117-
118-
# Local (requires Valkey installed: pip install django-valkey)
119-
INSTALL_VALKEY=true make test_local
120-
```
121-
122101
### Testing with Different Python Versions
123102

124103
```bash
125104
# Docker with Python 3.11
126105
PYTHON_VERSION=3.11 make test_docker
127106
128-
# Docker with Python 3.11 and Valkey
129-
PYTHON_VERSION=3.11 INSTALL_VALKEY=true make test_docker
130-
```
131-
132107
**Note:** Valkey support is optional and depends on `django-valkey`. If it's not installed, Valkey tests are automatically skipped.
133108
134109
### Run Specific Tests
@@ -215,7 +190,6 @@ When developing or testing, you can use these environment variables to control t
215190
216191
| Variable | Default | Description |
217192
|----------|---------|-------------|
218-
| `INSTALL_VALKEY` | `false` | Install `django-valkey` optional dependency |
219193
| `PYTHON_VERSION` | `3.10` | Python version to use in Docker containers |
220194
221195
### Examples
@@ -225,16 +199,9 @@ When developing or testing, you can use these environment variables to control t
225199
make install
226200
make test_docker
227201
228-
# With Valkey support (local)
229-
INSTALL_VALKEY=true make install
230-
231202
# Different Python version (Docker)
232203
PYTHON_VERSION=3.11 make docker_up
233204
234-
# All options combined
235-
PYTHON_VERSION=3.12 INSTALL_VALKEY=true make test_docker
236-
```
237-
238205
## Making Changes
239206
240207
### Adding a New Feature

docs/testing.md

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -53,26 +53,6 @@ pytest tests/
5353
pytest tests/ -v
5454
```
5555

56-
### Testing with Valkey Support
57-
58-
Django Cache Panel includes comprehensive testing for the optional Valkey backend:
59-
60-
```bash
61-
# Test with Valkey support enabled (Docker)
62-
INSTALL_VALKEY=true make test_docker
63-
64-
# Test locally with Valkey
65-
INSTALL_VALKEY=true make test_local
66-
67-
# Test with specific Python version
68-
PYTHON_VERSION=3.11 INSTALL_VALKEY=true make test_docker
69-
```
70-
71-
**Note:** When `INSTALL_VALKEY=false`:
72-
- `django_valkey` is not installed
73-
- Tests automatically skip Valkey backend
74-
- All other cache backends are tested normally
75-
7656
### Run Specific Tests
7757

7858
```bash

0 commit comments

Comments
 (0)