Add module docstrings #395
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
| # This workflow will install Python dependencies, run tests and lint | |
| # with a variety of Python versions For more information see: | |
| # https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions | |
| name: Test | |
| on: | |
| push: | |
| branches: | |
| - "main" | |
| pull_request: | |
| workflow_call: | |
| jobs: | |
| test: | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| python-version: | |
| - "3.9" | |
| - "3.10" | |
| - "3.11" | |
| os: | |
| - "ubuntu-22.04" | |
| - "windows-2022" | |
| - "macos-11" | |
| runs-on: ${{ matrix.os }} | |
| steps: | |
| - name: Check out sources | |
| uses: actions/checkout@v3 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| cache: 'pip' # caching pip dependencies | |
| cache-dependency-path: pyproject.toml | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| python -m pip install wheel coveralls | |
| # # TODO: we can't use flake8 right now, because there isn't a | |
| # # version of flake8 that can use pycodestyle==2.6.0, and fim has | |
| # # pinned pycodestyle==2.6.0. | |
| # - name: Lint with flake8 | |
| # run: | | |
| # # stop the build if there are Python syntax errors or undefined names | |
| # python -m flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics | |
| # # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide | |
| # python -m flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics | |
| - name: Install and test with pytest | |
| run: | | |
| python -m pip install .[test] | |
| python -m coverage run -m pytest | |
| python -m coverage report | |
| - name: Send coverage data to coveralls.io | |
| run: | | |
| python -m coveralls --service=github | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| COVERALLS_FLAG_NAME: ${{ matrix.python-version }} | |
| COVERALLS_PARALLEL: true | |
| finalize: | |
| name: finalize | |
| needs: test | |
| runs-on: ubuntu-latest | |
| container: python:3-slim | |
| steps: | |
| - name: Indicate completion to coveralls.io | |
| run: | | |
| python -m pip --no-cache-dir install --upgrade coveralls | |
| python -m coveralls --service=github --finish | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |