(seer) Confusing setup instructions

[mifu67]

Hey all, I'm having a very difficult time getting Seer set up via the instructions in the readme. Here are some things I've encountered:

• I see that there was a PR to switch from pyenv to devenv, but this isn't updated in the readme.
• direnv allow can take an extremely long time to run (about 6 minutes). This is not indicated in the readme, so it seems like the command is hanging. Also, the command fails:

  direnv: ([/Users/michellefu/.local/share/sentry-devenv/bin/direnv export zsh]) is taking a while to execute. Use CTRL-C to give up.
  WARNING: The candidate selected for download or install is a yanked version: 'requests' candidate (version 2.32.0 at https://files.pythonhosted.org/packages/24/e8/09e8d662a9675a4e4f5dd7a8e6127b463a091d2703ed931a64aa66d00065/requests-2.32.0-py3-none-any.whl (from https://pypi.org/simple/requests/) (requires-python:>=3.8))
  Reason for being yanked: Yanked due to conflicts with CVE-2024-35195 mitigation
  Executing update tasks in Makefile...
  docker compose build
  docker: 'compose' is not a docker command.
  See 'docker --help'
  make: *** [update] Error 1
  Command `make -C /Users/michellefu/code/seer update` failed! (code 2)
  direnv: export +GITHUB_APP_ID +GITHUB_PRIVATE_KEY +GITHUB_TOKEN +LANGFUSE_HOST +LANGFUSE_PUBLIC_KEY +LANGFUSE_SECRET_KEY +NO_REAL_MODELS +NO_SENTRY_INTEGRATION +OPENAI_API_KEY +RPC_SHARED_SECRET +VIRTUAL_ENV +VIRTUAL_ENV_PROMPT ~PATH

  After talking with some members of the AI/ML team, it seems like you need to install Docker Desktop to fix this. However, the rest of Sentry has switched to Colima, so engineers from other teams probably don't have Docker Desktop and their make will fail. (EDIT: after installing Docker Desktop, make dev hangs on docker compose up --build)

• Which keys are required for each service? It's not clear. For instance, anomaly detection definitely doesn't require an OpenAI key—but someone trying to run Seer from the README instructions alone won't know that.
• make dev fails:

  docker compose up --build
  unknown flag: --build
  See 'docker --help'.

  See the above comment about Docker Desktop.

In general, I think that A) the readme should be rewritten from the perspective of someone who has no familiarity with the Seer project at all, B) updates to the Seer development environment should be properly reflected in the readme, and C) the team could strongly consider using Colima vs Docker Desktop to standardize with the Sentry dev environment setup.

[trillville]

readme has been updated - thank you for the feedback @mifu67 !