update readme and add some tools (#36) #11
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
| # path .github/workflows/test.yaml | |
| # This workflow runs unit tests on every PR and after merges. | |
| # Features (as defined in project header): | |
| # - runs per PR level and after merge | |
| # - checks out code | |
| # - sets up Python environment | |
| # - installs dependencies via requirements.txt | |
| # - installs pytest and pytest-asyncio as test tool | |
| # - runs tests via pytest ./scl/test/ | |
| name: Unit Tests | |
| on: | |
| push: | |
| branches: [ main ] # after merge | |
| pull_request: # per PR level | |
| branches: [ main ] | |
| jobs: | |
| test: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| python-version: [ '3.13' ] | |
| steps: | |
| - name: Check out code | |
| 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 | |
| - name: Install test tools | |
| run: pip install pytest pytest-asyncio | |
| - name: Run unit tests | |
| run: pytest ./scl/test/ | |
| # Example usage: | |
| # This workflow is automatically triggered by: | |
| # - Pushing to main/master | |
| # - Creating, updating, or reopening a pull request targeting main/master | |
| # Developers can also manually trigger it via the "Actions" tab if needed. | |
| # To debug, inspect the "Run unit tests" step logs in the GitHub Actions console. | |
| # run test via pytest ./scl/test/ |