Skip to content

Python: [Samples][Python] azure_functions & durabletask READMEs need quick-install commands for prerequisites #5402

@leestott

Description

@leestott

Description

The azure_functions/README.md and durabletask/README.md list several external prerequisites but don't provide quick-install commands. A beginner hitting missing tools gets stuck at multiple points.

Prerequisite Status (tested on clean Windows 11)

Prerequisite Status Where Documented
Azure Functions Core Tools func not found azure_functions/README.md links to install docs
Azurite storage emulator azurite not found azure_functions/README.md links to install docs
Docker ✅ v29.4.0 durabletask/README.md mentions Docker
Azure CLI (az login) Both READMEs
uv ✅ v0.9.27 Not mentioned as prerequisite in most READMEs

Pain Points for Beginners

  1. Azurite: README links to docs but a beginner won't know to run npm install -g azurite. Also unclear that it must be running before func start.
  2. Azure Functions Core Tools: No version specified. Install method varies by OS.
  3. Flow is non-obvious: The steps are install Azurite → start Azurite → install Core Tools → copy template → set env vars → az loginfunc start. Many failure points with no troubleshooting guidance.

Suggested Fix

Add a "Quick Prerequisites Checklist" section at the top of each README with exact install commands:

# Windows
winget install Microsoft.Azure.FunctionsCoreTools
npm install -g azurite

# Verify
func --version
azurite --version

Also consider adding a scripts/setup.ps1 or similar to automate prerequisite checks.

Environment

  • Python 3.13.13, Windows 11, Docker 29.4.0

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationpython

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions