Skip to content

Python: [Samples][Python] Inconsistent config template naming across azure_functions samples (.template vs .sample vs .example) #5399

@leestott

Description

@leestott

Description

The azure_functions/ samples use three different naming conventions for configuration template files, which is confusing for beginners who follow the parent README's instructions.

Current State

Samples Local Settings Template Env File
01–08 local.settings.json.template (none)
09, 10, 12 local.settings.json.sample 10 has .env.sample
11 local.settings.json.sample .env.template

The parent azure_functions/README.md instructs: "Copy local.settings.json.template to local.settings.json". Beginners following this in samples 09-12 won't find a .template file.

Additionally, the .env template files use inconsistent suffixes:

  • .env.sample (sample 10)
  • .env.template (sample 11)
  • .env.example (foundry-hosted-agents samples)

Suggested Fix

Standardize on one naming convention across all samples. Recommend .template suffix for consistency with samples 01-08 and the parent README, or .example to match broader Python ecosystem conventions.

Environment

  • Python 3.13.13, Windows 11

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