Improve readme and documentation #150
Workflow file for this run
This file contains 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: Python package | |
| on: | |
| push: | |
| branches: | |
| - main | |
| pull_request: | |
| branches: | |
| - main | |
| jobs: | |
| build: | |
| name: Build for (${{ matrix.python-version }}, ${{ matrix.os }}) | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: ['ubuntu-latest', 'macos-latest', 'windows-latest'] | |
| python-version: ['3.10', '3.11'] | |
| env: | |
| MPLBACKEND: Agg # https://github.com/orgs/community/discussions/26434 | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v3 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Python info | |
| shell: bash -l {0} | |
| run: | | |
| which python3 | |
| python3 --version | |
| - name: Upgrade pip and install hatch | |
| run: | | |
| python3 -m pip install --upgrade pip hatch | |
| - name: Run unit tests | |
| run: hatch run test | |
| - name: Verify that we can build the package | |
| run: hatch build | |
| lint: | |
| name: Linting build | |
| runs-on: ubuntu-latest | |
| strategy: | |
| fail-fast: false | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Set up Python 3.10 | |
| uses: actions/setup-python@v3 | |
| with: | |
| python-version: "3.10" | |
| - name: Python info | |
| shell: bash -l {0} | |
| run: | | |
| which python3 | |
| python3 --version | |
| - name: Upgrade pip and install hatch & pre-commit | |
| run: python3 -m pip install --upgrade pip hatch pre-commit | |
| - name: Check style against standards | |
| run: hatch run lint | |
| - name: Verify that pre-commit agrees | |
| run: pre-commit |