azure-functions-doctor 0.15.1

Diagnostic tool for Azure Functions Python v2 programming model

Azure Functions Doctor

Read this in: 한국어 | 日本語 | 简体中文

Azure Functions Doctor is a diagnostic CLI for projects built on the Azure Functions Python v2 programming model.

It checks a local project for common issues such as:

• unsupported Python versions
• missing host.json or requirements.txt
• missing azure-functions dependency
• missing virtual environments
• missing Azure Functions Core Tools
• incomplete local development setup

Why Use It

Setting up an Azure Functions Python project involves multiple configuration files, dependencies, and tooling. Missing any one of them leads to confusing runtime errors. azure-functions-doctor checks your project against a curated ruleset and reports issues before they reach production.

Scope

This repository targets the decorator-based Azure Functions Python v2 programming model only.

• Supported model: func.FunctionApp() with decorators such as @app.route()
• Unsupported model: legacy function.json-based Python v1 projects

Installation

From PyPI:

pip install azure-functions-doctor

From source:

git clone https://github.com/yeongseon/azure-functions-doctor.git
cd azure-functions-doctor
python3 -m venv .venv
source .venv/bin/activate
pip install -e .

Quick Start

Run the doctor in the current project:

azure-functions doctor

Run against a specific project:

azure-functions doctor --path ./examples/v2/http-trigger

Use a required-only profile:

azure-functions doctor --profile minimal

Output JSON for CI:

azure-functions doctor --format json

Demo

The demo below is generated from demo/doctor-demo.tape with VHS. It runs the real azure-functions doctor CLI against the representative example and then against an intentionally broken copy to show the pass/fail contrast.

The final terminal state is also captured as a static image for quick inspection.

Features

The default ruleset includes checks for:

• Azure Functions Python v2 decorator usage
• Python version
• virtual environment activation
• Python executable availability
• requirements.txt
• azure-functions dependency declaration
• host.json
• local.settings.json (optional)
• Azure Functions Core Tools presence and version (optional)
• Durable Functions host configuration (optional)
• Application Insights configuration (optional)
• extensionBundle configuration (optional)
• ASGI/WSGI callable exposure (optional)
• common unwanted files in the project tree (optional)

Examples

• examples/v2/http-trigger/README.md
• examples/v2/multi-trigger/README.md

Requirements

• Python 3.10+
• Hatch for development workflows
• Azure Functions Core Tools v4+ recommended for local runs

Documentation

• docs/index.md
• docs/usage.md
• docs/rules.md
• docs/diagnostics.md
• docs/development.md

Ecosystem

• azure-functions-validation — Request and response validation
• azure-functions-openapi — OpenAPI and Swagger UI
• azure-functions-logging — Structured logging
• azure-functions-scaffold — Project scaffolding
• azure-functions-python-cookbook — Recipes and examples

Disclaimer

This project is an independent community project and is not affiliated with, endorsed by, or maintained by Microsoft.

Azure and Azure Functions are trademarks of Microsoft Corporation.

License

MIT