Skip to content

feat: Add base image details and Python version management guide #1114

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

codegen-sh[bot]
Copy link
Contributor

@codegen-sh codegen-sh bot commented May 30, 2025

Summary

This PR updates the sandbox documentation to address customer support requests about Python version compatibility, specifically for packages like argis==2.4.0 that require Python 3.12.

Changes Made

Base Image Documentation

  • Added comprehensive "Base Image" section with complete Dockerfile
  • Documented the Python 3.13 default environment
  • Listed all available tools and package managers (uv, npm, yarn, pnpm, etc.)
  • Included Node.js 22.14.0 and essential development tools

Python Version Management

  • Added "Working with Different Python Versions" section
  • Documented three approaches:
    1. pyenv for multiple Python versions
    2. uv package manager for version management
    3. Virtual environment best practices

Setup Command Examples

  • Added practical examples for Python version setup
  • Included commands for creating virtual environments with specific Python versions
  • Added warnings about activating virtual environments in setup commands

Customer Impact

This directly addresses the support channel question about forcing Python 3.12 for dependencies that aren't compatible with Python 3.13. Users can now:

  • Understand what's included in the base sandbox image
  • Set up Python 3.12 environments for compatibility
  • Use proper virtual environment practices
  • Configure setup commands for their specific Python version needs

Related

  • Addresses customer support request from Slack thread
  • Follows repo rules for .mdx format in docs/ directory
  • Updates docs/sandboxes/setup-commands.mdx as requested

💻 View my workAbout Codegen

- Added comprehensive base image section with complete Dockerfile
- Documented Python 3.13 default and available tools
- Added guides for using pyenv and uv for different Python versions
- Included virtual environment best practices for compatibility
- Added setup command examples for Python version management

Addresses customer support request for Python 3.12 compatibility with packages like argis==2.4.0
Copy link

codecov bot commented May 30, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

✅ All tests successful. No failed tests found.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Contributor Author

codegen-sh bot commented May 30, 2025

I see a check failed - I'm on it! 🫡

💻 View my work

@kopekC kopekC marked this pull request as ready for review May 30, 2025 03:09
@kopekC kopekC requested review from codegen-team and a team as code owners May 30, 2025 03:09
@kopekC kopekC changed the title docs: Add base image details and Python version management guide feat: Add base image details and Python version management guide May 30, 2025
@kopekC kopekC merged commit 5eb2997 into develop May 30, 2025
15 of 16 checks passed
@kopekC kopekC deleted the codegen-bot/update-docs-base-image-python-versions-1748573219 branch May 30, 2025 03:09
Copy link
Contributor Author

codegen-sh bot commented May 30, 2025

I encountered some technical issues while trying to diagnose the failing check suite. The environment appears to have been terminated and I was experiencing timeouts when trying to access logs and run tests locally.

However, based on the information I was able to gather:

The Issue:

Most Likely Causes:

  1. MDX Syntax Issues: The new documentation might have syntax errors in the MDX format
  2. Documentation Structure Validation: Tests might be checking that the docs.json structure matches the actual documentation files
  3. Link Validation: Tests might be validating internal links or references
  4. Linting Issues: Code formatting or style issues in the documentation

Recommended Next Steps:

  1. Check the PR directly on GitHub - Look at the "Checks" tab on the PR to see if there are any error details visible
  2. Validate MDX syntax - Use an online MDX validator to check the documentation changes
  3. Review the changes - Compare the new content against existing documentation patterns in the repo
  4. Check for broken links - Ensure any internal references or links are correct

Would you like me to start a new session to continue investigating this issue? I can then access the specific error details and provide a more targeted fix.

💻 View my work • React 👍 or 👎

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