Expand descriptions of LSH-relevant arguments in README and help messages #21
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://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python | |
| name: build | |
| on: | |
| push: | |
| branches: | |
| - '**' # build for all branches | |
| pull_request: | |
| branches: | |
| - 'master' # build for pull requests into master | |
| jobs: | |
| build: | |
| # build on all combinations of OS and Python version | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: [ubuntu-latest, macos-latest] | |
| python-version: ["3.8", "3.9", "3.10"] | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v3 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| python -m pip install pytest pytest-cov | |
| pip3 install -r requirements.txt | |
| pip3 install . | |
| - name: Lint with flake8 | |
| run: | | |
| pip install flake8 | |
| # stop the build if there are Python syntax errors or undefined names | |
| flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics | |
| # exit-zero treats all errors as warnings. Check for 80 char max line length | |
| flake8 . --count --exit-zero --max-complexity=10 --max-line-length=80 --statistics | |
| - name: Test with pytest | |
| run: | | |
| # run pytest and save coverage report for codecov | |
| pytest --cov=./ --cov-report=xml | |
| - name: Upload coverage to Codecov | |
| if: ${{ runner.os == 'Linux' && matrix.python-version == '3.8' }} # only upload for Python 3.8 on Linux | |
| uses: codecov/codecov-action@v3 | |
| with: | |
| env_vars: OS,PYTHON | |
| fail_ci_if_error: false | |
| flags: unittests | |
| name: codecov-umbrella | |
| verbose: true |