envdoc 0.1.0

Scan Python codebases for env var usage and auto-generate .env.example + Markdown config reference

envdoc

Scan your Python codebase for environment variable usage. Auto-generate .env.example and a Markdown config reference.

Every project has undocumented environment variables. Someone runs it cold, nothing works, and there's no .env.example to tell them what's missing. envdoc fixes that — it scans your code, finds every os.getenv, os.environ, and common pattern, and writes the documentation for you. $ envdoc scan ./src Found 7 environment variables in 12 files ANTHROPIC_API_KEY src/llm/client.py:14 DATABASE_URL src/db/connection.py:8 LOG_LEVEL src/app.py:22 PORT src/app.py:31 REDIS_URL src/cache.py:11 SECRET_KEY src/auth.py:9 SENTRY_DSN src/monitoring.py:4 Generated: .env.example

---

Install

pip install envdoc

Usage

# Scan and write .env.example
envdoc scan ./src

# Markdown config reference (for docs)
envdoc scan ./src --format markdown

# CI mode — exit 1 if .env.example is stale
envdoc scan ./src --check

# Write to a specific file
envdoc scan ./src --output docs/config.md --format markdown

CI integration

- name: Check .env.example is up to date
  run: envdoc scan ./src --check

Any new env var added to the codebase without updating .env.example fails the build.

---

Roadmap

• Core scanner: os.getenv, os.environ
• #2 Pydantic BaseSettings detection
• #3 python-dotenv load_dotenv key detection
• #4 pre-commit hook integration
• #5 Nested env access in f-strings
• #6 GitHub Action wrapper

---

Contributing

See CONTRIBUTING.md.

License

MIT — see LICENSE.