docs(repo): rewrite README with banner, structured sections, and badges #32
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: [ '**' ] | |
| pull_request: | |
| branches: [ '**' ] | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| python-version: ['3.9', '3.10', '3.11'] | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install tools | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install -e ".[ci]" | |
| - name: Lint (Ruff) | |
| run: | | |
| ruff check . | |
| - name: Format check (Black) | |
| run: | | |
| black --check src examples tests | |
| - name: Type check (MyPy) | |
| run: | | |
| mypy --install-types --non-interactive | |
| - name: Install package | |
| run: | | |
| pip install . | |
| - name: Run tests | |
| run: | | |
| pytest -q |