Skip to content

chore: document & enforce python runtime + add .env.example  #119

@arceuzvx

Description

@arceuzvx

Summary

Contributors are encountering dependency resolution errors (e.g., TensorFlow pip errors) because the repository does not declare a supported Python runtime. This causes installations to fail on modern Python versions (>=3.11). We should declare a supported Python version, provide an .env.example, and add a minimal CI check to prevent environment friction for contributors.

Problem / Reproduction

  1. On a machine running Python 3.11+:
    python --version
    pip install -r backend/requirements.txt
  2. pip fails with messages such as:
      Could not find a version that satisfies the requirement tensorflow==2.17.0
      Ignored the following versions that require a different python version: 
    
Image
  1. This blocks new contributors from running the project locally and submitting PRs.

Proposal (minimal, high-impact)

  1. Add a runtime declaration file: .python-version (content: 3.9.19) OR runtime.txt to explicitly declare the supported Python runtime (like: 3.9 or 3.10).
  2. Add .env.example at repo root listing required environment variables (no secrets).
  3. Update CONTRIBUTING.md or SETUP.md with one-line setup steps for conda/pyenv/venv so contributors can reproduce a working environment.

Metadata

Metadata

Assignees

Labels

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions