Skip to content

Update installation command to include all dependencies - #17

Merged
agileguy merged 1 commit into
mainfrom
doc-patch
Dec 16, 2025
Merged

agileguy merged 1 commit into
mainfrom
doc-patch

Conversation

@agileguy

@agileguy agileguy commented Dec 16, 2025 •

Copy link
Copy Markdown
Owner

Note

Change From Source install instruction in README to use pip install -e ".[all]" instead of ".[dev]".

Written by Cursor Bugbot for commit 32815c5. This will update automatically on new commits. Configure here.

@claude

claude Bot commented Dec 16, 2025

Copy link
Copy Markdown

PR Review: Update installation command to include all dependencies

Summary

This PR changes the "From Source (Development)" installation command from pip install -e ".[dev]" to pip install -e ".[all]".


✅ Approved - Good Change

This is a positive improvement that aligns the development installation instructions with best practices.


Analysis

What Changed

  • Line 89 of README.md: pip install -e ".[dev]" → pip install -e ".[all]"

Why This Is Correct

  1. Complete Development Environment: The [all] extras include all optional dependencies (gcp, gke, docker, detection) that developers need to work on and test all adapters and features.

  2. Alignment with pyproject.toml: Looking at pyproject.toml:

    • [all] includes: GCP, GKE, Docker, and detection dependencies (lines 46-52)
    • [dev] includes: pytest, mypy, ruff, coverage, etc. (lines 53-61)
  3. Best Practice: Developers should install:

    • [all] for runtime dependencies (to test all features)
    • [dev] for development tools (testing, linting, type checking)

Recommendation

The change is good, but there's an even better approach. Developers typically need both [all] AND [dev]:

# Install both runtime features AND dev tools
pip install -e ".[all,dev]"

This ensures developers have:

  • ✅ All optional runtime dependencies (GCP, GKE, Docker, detection)
  • ✅ All development tools (pytest, mypy, ruff, coverage)

Suggested Follow-up (Optional)

Consider updating line 89 to:

pip install -e ".[all,dev]"

This provides the complete development environment in a single command.


Code Quality Checks

  • ✅ No code changes - documentation only
  • ✅ No security concerns
  • ✅ No performance impact
  • ✅ No test coverage needed (README change)
  • ✅ Follows semantic versioning (PATCH-level doc fix)

Verdict

LGTM 👍 - This change improves the development setup instructions. Consider the optional enhancement above for an even better developer experience.

@agileguy
agileguy merged commit f00690b into main Dec 16, 2025
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant