README.md

March 12, 2026 ยท View on GitHub

This is a Redis starter template for Python using:

Requirements

Getting started

Copy and edit the .env file:

cp .env.example .env

Your .env file should contain the connection string you copied from Redis Cloud.

Available settings:

  • APP_ENV=development|test|production
  • LOG_LEVEL=DEBUG|INFO|WARNING|ERROR|CRITICAL
  • LOG_STREAM_KEY=logs
  • PORT=8080
  • REDIS_URL=redis://...

For docker, .env.docker should use container-internal addresses. Example:

APP_ENV=production
LOG_LEVEL=INFO
LOG_STREAM_KEY=logs
REDIS_URL="redis://redis:6379"

Next, spin up docker containers:

make docker

You should have a server running on http://localhost:<port> where the port is set in your .env file (default is 8080). You can test the following routes:

  1. GET /api/todos - Gets all todos
  2. GET /api/todos/:id - Gets a todo by ID
  3. GET /api/todos/search?[name=<name>]&[status=<status>] - Search for todos by name and/or status
  4. POST /api/todos - Create a todo with { "name": "Sample todo" }
  5. PATCH /api/todos/:id - Update todo by ID with { "status": "todo|in progress|complete" }
  6. DELETE /api/todos/:id - Delete a todo by ID

Todos are serialized with JS-compatible camelCase timestamps:

  • createdDate
  • updatedDate

Validation and client errors use the JSON envelope:

{ "status": 400, "message": "Todo must have a name" }

Logging

Requests and component logs are written to stdout. They are also shipped to Redis as stream entries via XADD on the key configured by LOG_STREAM_KEY (default logs).

Running tests

The test suite lives in __test__ and can be run with:

make test

If REDIS_URL points at the default local Redis and nothing is listening on it, the tests will start the redis service with docker compose automatically and stop it afterward.

Running locally outside docker

Install dependencies and run the dev server:

make install
make dev

For a production-style server:

make serve

Other scripts

Run make to see the list of available commands.

Useful targets:

  • make format
  • make lint
  • make update
  • make lock

Connecting to Redis Cloud

If you don't yet have a database setup in Redis Cloud get started here for free.

To connect to a Redis Cloud database, log into the console and find the following:

  1. The public endpoint
  2. Your username
  3. Your password

Combine them into a connection string and put it in .env and .env.docker. Example:

REDIS_URL="redis://default:<password>@redis-#####.c###.us-west-2-#.ec2.redns.redis-cloud.com:#####"

Run make test to verify the connection.

Learn more