Skip to content

Polish readme with uv for local running#19

Open
rkm3 wants to merge 1 commit into
a2hill:mainfrom
rkm3:rkm3/readme-polish
Open

Polish readme with uv for local running#19
rkm3 wants to merge 1 commit into
a2hill:mainfrom
rkm3:rkm3/readme-polish

Conversation

@rkm3
Copy link
Copy Markdown

@rkm3 rkm3 commented May 19, 2026

This is pretty minor, but I wanted to share the steps I used to get this running quickly.

Summary

  • Expand README with uv sync instructions for local development and examples
  • Update the example run command to use uv run and .secrets filtering
  • Add .venv/ to .gitignore and commit uv.lock for reproducible dev dependencies

Test plan

  • uv sync --extra dev succeeds on a clean checkout
  • env $(grep -v '^#' .secrets | xargs) uv run python examples/get_devices_for_user.py runs (with valid credentials)

Made with Cursor

Add uv sync instructions to the README, ignore .venv, and commit uv.lock for reproducible local development.

Co-authored-by: Cursor <cursoragent@cursor.com>
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