fix doc and README #66
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: tests | |
| on: | |
| push: | |
| branches: [ "main" ] | |
| pull_request: | |
| branches: [ "main" ] | |
| permissions: | |
| contents: read | |
| jobs: | |
| test-nucs: | |
| name: Test NUCS | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| python-version: ["3.9", "3.12"] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install -r requirements.txt | |
| pip install -r requirements-dev.txt | |
| - name: Fix the imports with isort | |
| run: | | |
| isort --trailing-comma nucs tests | |
| - name: Format code with black | |
| run: | | |
| black nucs tests | |
| - name: Fix style with flake8 | |
| run: | | |
| flake8 nucs tests | |
| - name: Check typing with mypy | |
| run: | | |
| mypy --disallow-untyped-defs --ignore-missing-imports nucs tests | |
| - name: Test with pytest | |
| run: | | |
| PYTHONPATH=. pytest tests |