initial commit

Author: wjohnsto

.dockerignore

@@ -0,0 +1,9 @@
+# Python
+__pycache__
+*.pyc
+.mypy_cache
+.coverage
+htmlcov
+.venv
+.env
+.env.*

.env.docker

@@ -0,0 +1,2 @@
+REDIS_URL="redis://redis:6379"
+

.env.example

@@ -0,0 +1,3 @@
+PORT=8000
+REDIS_URL="redis://localhost:6379"
+

.gitignore

@@ -0,0 +1,12 @@
+# Python
+__pycache__
+*.pyc
+.mypy_cache
+.ruff_cache
+.coverage
+htmlcov
+.venv
+.env
+.env.*
+!.env.docker
+!.env.example

Dockerfile

@@ -0,0 +1,41 @@
+FROM python:3.12-slim
+ENV PYTHONUNBUFFERED=1
+WORKDIR /app/
+
+COPY --from=ghcr.io/astral-sh/uv:latest /uv /uvx /bin/
+
+# Place executables in the environment at the front of the path
+# Ref: https://docs.astral.sh/uv/guides/integration/docker/#using-the-environment
+ENV PATH="/app/.venv/bin:$PATH"
+
+# Compile bytecode
+# Ref: https://docs.astral.sh/uv/guides/integration/docker/#compiling-bytecode
+ENV UV_COMPILE_BYTECODE=1
+
+# uv Cache
+# Ref: https://docs.astral.sh/uv/guides/integration/docker/#caching
+ENV UV_LINK_MODE=copy
+
+# Install dependencies
+# Ref: https://docs.astral.sh/uv/guides/integration/docker/#intermediate-layers
+RUN --mount=type=cache,target=/root/.cache/uv \
+    --mount=type=bind,source=uv.lock,target=uv.lock \
+    --mount=type=bind,source=pyproject.toml,target=pyproject.toml \
+    uv sync --frozen --no-install-project
+
+ENV PYTHONPATH=/app
+
+COPY ./pyproject.toml ./uv.lock /app/
+COPY ./app /app/app
+
+# Sync the project
+# Ref: https://docs.astral.sh/uv/guides/integration/docker/#intermediate-layers
+RUN --mount=type=cache,target=/root/.cache/uv \
+    uv sync
+
+ENV PORT 8080
+
+EXPOSE ${PORT}
+
+CMD ["sh", "-c", "fastapi run --port ${PORT} app/main.py"]
+

Makefile

@@ -0,0 +1,23 @@
+install:
+	@uv sync
+
+dev: install
+	@fastapi dev app/main.py
+
+serve: install
+	@fastapi run app/main.py
+
+docker:
+	@docker compose up -d
+
+format: install
+	@ruff check app --fix
+	@ruff format app
+
+lint: install
+	@mypy app
+	@ruff check app
+	@ruff format app --check
+
+clean:
+	@rm -rf .venv/ .mypy_cache/ .ruff_cache/

README.md

@@ -0,0 +1,95 @@
+This is a [Redis](https://redis.io/) starter template for Go:
+
+- [Redis Cloud](https://redis.io/try-free/)
+- [Echo](https://echo.labstack.com/)
+
+## Getting started
+
+Copy and edit the `.env` file:
+
+```bash
+cp .env.example .env
+```
+
+Your `.env` file should contain the connection string you copied from Redis Cloud.
+
+Your `.env.docker` file will look similar to `.env`, but should use the appropriate docker internal URLs. Here is
+an example:
+
+```bash
+REDIS_URL="redis://redis:6379"
+```
+
+Next, spin up docker containers:
+
+```bash
+make docker
+```
+
+You should have a server running on `http://localhost:<port>` where the port is set in your `.env` file (default is 8000). 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?[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
+
+## Running tests
+
+## Running locally outside docker
+
+To run the development server outside of docker:
+
+```bash
+make dev
+```
+
+## Other Scripts
+
+Run a production server outside of docker:
+
+```bash
+make serve
+```
+
+Formatting code:
+
+```bash
+make format
+```
+
+Linting:
+
+```bash
+make lint
+```
+
+## Connecting to Redis Cloud
+
+If you don't yet have a database setup in Redis Cloud [get started here for free](https://redis.io/try-free/).
+
+To connect to a Redis Cloud database, log into the console and find the following:
+
+1. The `public endpoint` (looks like `redis-#####.c###.us-east-1-#.ec2.redns.redis-cloud.com:#####`)
+1. Your `username` (`default` is the default username, otherwise find the one you setup)
+1. Your `password` (either setup through Data Access Control, or available in the `Security` section of the database
+   page.
+
+Combine the above values into a connection string and put it in your `.env` and `.env.docker` accordingly. It should
+look something like the following:
+
+```bash
+REDIS_URL="redis://default:<password>@redis-#####.c###.us-west-2-#.ec2.redns.redis-cloud.com:#####"
+```
+
+Run the [tests](#running-tests) to verify that you are connected properly.
+
+## Learn more
+
+To learn more about Redis, take a look at the following resources:
+
+- [Redis Documentation](https://redis.io/docs/latest/) - learn about Redis products, features, and commands.
+- [Learn Redis](https://redis.io/learn/) - read tutorials, quick starts, and how-to guides for Redis.
+- [Redis Demo Center](https://redis.io/demo-center/) - watch short, technical videos about Redis products and features.
+

app/__init__.py

@@ -0,0 +1,15 @@
+from typing import Union
+
+from fastapi import FastAPI
+
+app = FastAPI()
+
+
+@app.get("/")
+def read_root():
+    return {"Hello": "World"}
+
+
+@app.get("/items/{item_id}")
+def read_item(item_id: int, q: Union[str, None] = None):
+    return {"item_id": item_id, "q": q}

app/main.py

@@ -0,0 +1,31 @@
+name: redis-starter-python
+services:
+  redis:
+    container_name: redis
+    image: "redis:8.0-M02"
+    ports:
+      - 6379:6379
+    deploy:
+      replicas: 1
+      restart_policy:
+        condition: on-failure
+    volumes:
+      - redis-data:/data
+
+  server:
+    container_name: server
+    build: .
+    ports:
+      - "${PORT-8080}:${PORT-8080}"
+    environment:
+      PORT: ${PORT-8080}
+    env_file:
+      - .env
+      - .env.docker
+    restart: always
+    depends_on:
+      - redis
+
+volumes:
+  redis-data:
+

compose.yml

@@ -0,0 +1,59 @@
+[project]
+name = "redis-starter-python"
+version = "0.1.0"
+description = "A starter project for working with Redis and Python"
+authors = [
+  { name = "Will Johnston", email = "[email protected]" }
+]
+maintainers = [
+  { name = "Will Johnston", email = "[email protected]" }
+]
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.8"
+keywords = ["python", "fastapi", "redis", "starter", "redis-py"]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Intended Audience :: Developers",
+  "Programming Language :: Python"
+]
+dependencies = ["fastapi[standard] (>=0.115.6,<0.116.0)"]
+
+[project.urls]
+Repository = "https://github.com/redis-developer/redis-starter-python.git"
+"Bug Tracker" = "https://github.com/redis-developer/redis-starter-python/issues"
+
+[project.optional-dependencies]
+dev = [
+    "mypy<2.0.0,>=1.8.0",
+    "ruff<1.0.0,>=0.2.2",
+]
+
+[tool.mypy]
+strict = true
+
+[tool.ruff]
+target-version = "py38"
+
+[tool.ruff.lint]
+select = [
+    "E",  # pycodestyle errors
+    "W",  # pycodestyle warnings
+    "F",  # pyflakes
+    "I",  # isort
+    "B",  # flake8-bugbear
+    "C4",  # flake8-comprehensions
+    "UP",  # pyupgrade
+    "ARG001", # unused arguments in functions
+]
+ignore = [
+    "E501",  # line too long, handled by black
+    "B008",  # do not perform function calls in argument defaults
+    "W191",  # indentation contains tabs
+    "B904",  # Allow raising exceptions without from e, for HTTPException
+]
+
+[tool.ruff.lint.pyupgrade]
+# Preserve types, even if a file imports `from __future__ import annotations`.
+keep-runtime-typing = true
+