docs: document PYTHONPATH requirement for Docker hot reload #846
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When mounting local code over /app in docker-compose.override.yml, Python can't find installed packages unless PYTHONPATH is explicitly set. This was missing from all documentation and setup scripts, causing confusing ModuleNotFoundError when developers tried to use hot reload. Added PYTHONPATH configuration to docker-compose.override.example.yml, the Conductor workspace setup script, and troubleshooting/setup documentation with clear explanations of why it's needed. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
|
| GitGuardian id | GitGuardian status | Secret | Commit | Filename | |
|---|---|---|---|---|---|
| 19556361 | Triggered | Generic Password | bc57596 | docker-compose.override.example.yml | View secret |
🛠 Guidelines to remediate hardcoded secrets
- Understand the implications of revoking this secret by investigating where it is used in your code.
- Replace and store your secret safely. Learn here the best practices.
- Revoke and rotate this secret.
- If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.
To avoid such incidents in the future consider
- following these best practices for managing and storing secrets including API keys and other credentials
- install secret detection on pre-commit to catch secret before it leaves your machine and ease remediation.
🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.
Major simplifications to make onboarding easier for new developers: - README Quick Start reduced from 6 steps to 4 steps - New clean .env.template with clear Required/Optional sections - Removed confusing 'source .env.secrets &&' pattern - Docker Compose auto-reads .env - Deleted redundant .env.example (156 lines of duplication) - Simplified docs/SETUP.md from ~450 to ~200 lines - Removed incorrect SQLite reference (PostgreSQL only) - Removed stale CI trigger comment New setup flow: git clone → cp .env.template .env → edit → docker-compose up 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When mounting local code over /app in docker-compose.override.yml, Python can't find installed packages unless PYTHONPATH is explicitly set. This was missing from documentation and setup scripts, causing ModuleNotFoundError for developers.
Added PYTHONPATH configuration to example files, setup script, and troubleshooting documentation with clear explanations of the issue and fix. Includes a note that the Python version must match the Dockerfile.
Fixes the development setup gap identified during workspace setup.