azure-functions-doctor 0.1.9

A diagnostic tool for Python Azure Functions

---

🚑 Azure Functions Doctor for Python

A fast and extensible diagnostic CLI for Python-based Azure Functions projects.

---

🤔 Why Azure Functions Doctor?

• Getting random 500 errors and suspect misconfiguration?
• Need to verify your dev environment before CI/CD deployment?
• Want a quick health check without digging through docs?

Azure Functions Doctor helps save time by automating common environment diagnostics.

---

✨ Key Features

• Diagnose Python version, venv, azure-functions package
• Validate host.json, local.settings.json, function structure
• Fully customizable via rules.json
• Output: colorized CLI or machine-readable JSON
• Built-in rule engine, easily extensible

---

🪠 Requirements

• Python 3.9+
• Git
• (Optional) Azure Functions Core Tools v4+ (npm i -g azure-functions-core-tools@4)
• (Recommended) Unix-like shell or PowerShell for Makefile support

---

📦 Installation

From PyPI:

pip install azure-functions-doctor

Or from source:

git clone https://github.com/yeongseon/azure-functions-doctor-for-python.git
cd azure-functions-doctor-for-python
python3 -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
pip install -e .

---

🩺 Usage

Run the Doctor

func-doctor diagnose

Show Help

func-doctor --help

📌 Sample: examples/basic-hello/diagnose-output.md

---

📋 Example

See examples/basic-hello for:

• Minimal Azure Functions structure setup
• Running the CLI and inspecting results

---

📘 Documentation

• Getting Started: docs/index.md
• Custom Rules: docs/rules.md
• Developer Guide: docs/development.md

---

🤝 Contributing

We welcome issues and PRs!

Please see CONTRIBUTING.md for contribution guidelines.

If you find this useful, please ⭐️ the repo!

---

📄 License

This project is licensed under the MIT License.