docs: add a Quick start section to README.md #1374
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
| name: CI | |
| on: | |
| push: | |
| branches: [main] | |
| pull_request: | |
| jobs: | |
| test: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Install uv | |
| uses: astral-sh/setup-uv@v5 | |
| with: | |
| python-version: "3.13" | |
| enable-cache: true | |
| - name: Sync dependencies | |
| run: uv sync | |
| - name: Lint (ruff) | |
| run: uv run ruff check | |
| - name: Format check (ruff) | |
| run: uv run ruff format --check | |
| - name: Type-check (mypy) | |
| run: uv run mypy --package panopticon | |
| - name: Test (pytest) | |
| run: uv run pytest |