azure-functions-doctor 0.15.0

Diagnostic tool for Azure Functions Python v2 programming model

Azure Functions Doctor

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

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

Requirements

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

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 .

Usage

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.

Built-in checks

The default ruleset validates:

• 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

Documentation

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

Contributing

See CONTRIBUTING.md.

License

This project is licensed under the MIT License.