Turn tomli into an optional dependency (#436) #1424
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
| name: CI | |
| on: | |
| push: | |
| paths-ignore: | |
| - 'CHANGELOG.md' | |
| branches: [main] | |
| pull_request: | |
| branches: [main] | |
| schedule: | |
| - cron: '0 11 * * 4' | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| pre-commit: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| - uses: pre-commit/[email protected] | |
| pyright: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.13' | |
| cache: 'pip' | |
| - run: | | |
| python -m venv .venv | |
| source .venv/bin/activate | |
| pip install pandas-stubs | |
| pip install -e .[test] | |
| - run: echo "$PWD/.venv/bin" >> $GITHUB_PATH | |
| - name: Run Pyright | |
| uses: jakebailey/pyright-action@v2 | |
| with: | |
| pylance-version: latest-release | |
| codeql: | |
| runs-on: ubuntu-latest | |
| permissions: | |
| security-events: write | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Initialize CodeQL | |
| uses: github/codeql-action/init@v3 | |
| with: | |
| languages: python, javascript | |
| - name: Perform CodeQL Analysis | |
| uses: github/codeql-action/analyze@v3 | |
| pytest: | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| python-version: [3.9, "3.10", "3.11", "3.12", "3.13"] | |
| pandas-version: [latest] | |
| numpy-version: [latest] | |
| typeguard-version: [latest] | |
| include: | |
| - python-version: 3.9 | |
| pandas-version: '<2.0' | |
| numpy-version: '<2.0' | |
| - python-version: "3.13" | |
| pandas-version: pre | |
| - python-version: "3.13" | |
| uninstall_non_essential_dependencies: true | |
| - python-version: "3.10" | |
| typeguard-version: "<4.4.1" | |
| - python-version: "3.10" | |
| typeguard-version: "<4" | |
| runs-on: ubuntu-24.04 | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Set up Node | |
| uses: actions/setup-node@v4 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install a development version of 'itables' | |
| run: pip install -e .[test] | |
| - name: Install pandas latest | |
| if: matrix.pandas-version == 'latest' | |
| run: pip install pandas | |
| - name: Install pandas pre-release | |
| if: matrix.pandas-version == 'pre' | |
| run: pip install pandas --pre | |
| - name: Install pandas ${{ matrix.pandas-version }} | |
| if: matrix.pandas-version != 'pre' && matrix.pandas-version != 'latest' | |
| run: pip install 'pandas${{ matrix.pandas-version }}' | |
| - name: Install numpy ${{ matrix.numpy-version }} | |
| if: matrix.numpy-version != 'latest' | |
| run: pip install 'numpy${{ matrix.numpy-version }}' | |
| - name: Install typeguard ${{ matrix.typeguard-version }} | |
| if: matrix.typeguard-version != 'latest' | |
| run: pip install 'typeguard${{ matrix.typeguard-version }}' | |
| - name: Install shiny | |
| run: pip install "shiny>=1.0" shinywidgets | |
| - name: Uninstall non-essential dependencies | |
| if: matrix.uninstall_non_essential_dependencies | |
| run: pip uninstall polars jinja2 dash anywidget streamlit shiny shinywidgets -y | |
| - name: Install a Jupyter Kernel | |
| run: python -m ipykernel install --name itables --user | |
| - name: Test with pytest | |
| run: pytest --cov=./ --cov-report=xml | |
| - name: Upload coverage | |
| uses: codecov/codecov-action@v3 | |
| with: | |
| fail_ci_if_error: true | |
| verbose: true | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout source | |
| uses: actions/checkout@v4 | |
| - name: Set up Node | |
| uses: actions/setup-node@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: 3.11 | |
| - name: Install hatch | |
| run : pip install hatch | |
| - name: Build package | |
| run: hatch build | |
| - name: Check LICENSE.txt in wheel | |
| run: unzip -l dist/*.whl | grep -q itables_for_dash/async-ITable.js.LICENSE.txt | |
| - name: Check LICENSE.txt in sdist | |
| run: tar -tvf dist/*.tar.gz | grep -q itables_for_dash/async-ITable.js.LICENSE.txt | |
| # Upload the wheel as an artifact | |
| - name: Upload wheel artifact | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: itables-wheel | |
| path: dist/*.whl | |
| # Comment on PR with artifact link (only on PRs) | |
| - name: Comment with direct artifact link | |
| if: github.event_name == 'pull_request' | |
| uses: actions/github-script@v7 | |
| with: | |
| script: | | |
| const pr_number = context.payload.pull_request.number; | |
| const run_id = context.runId; | |
| const marker = '<!-- itables-artifact-link -->'; | |
| // List artifacts for this run | |
| const { data: { artifacts } } = await github.rest.actions.listWorkflowRunArtifacts({ | |
| owner: context.repo.owner, | |
| repo: context.repo.repo, | |
| run_id: run_id, | |
| }); | |
| // Find the artifact named 'itables-wheel' | |
| const artifact = artifacts.find(a => a.name === 'itables-wheel'); | |
| let artifact_url; | |
| if (artifact) { | |
| artifact_url = `https://github.com/${context.repo.owner}/${context.repo.repo}/actions/runs/${run_id}/artifacts/${artifact.id}`; | |
| } else { | |
| artifact_url = `https://github.com/${context.repo.owner}/${context.repo.repo}/actions/runs/${run_id}#artifacts`; | |
| } | |
| const body = `${marker} | |
| Thank you for making this pull request. | |
| Did you know? You can try it on Binder: [](https://mybinder.org/v2/gh/${{ github.event.pull_request.head.repo.full_name }}/${{ github.event.pull_request.head.ref }}?urlpath=lab/tree/docs/quick_start.md). | |
| Also, the version of ITables developed in this PR is available as a wheel artifact :package: for easy installation. | |
| Download it [here](${artifact_url}), unzip it and then run <code>pip install itables-xxx.whl</code> in the unzipped directory.`; | |
| // List comments on the PR | |
| const { data: comments } = await github.rest.issues.listComments({ | |
| owner: context.repo.owner, | |
| repo: context.repo.repo, | |
| issue_number: pr_number, | |
| }); | |
| // Find existing comment by this workflow (by marker) | |
| const existing = comments.find( | |
| c => c.user.type === 'Bot' && c.body && c.body.includes(marker) | |
| ); | |
| if (existing) { | |
| // Update the existing comment | |
| await github.rest.issues.updateComment({ | |
| owner: context.repo.owner, | |
| repo: context.repo.repo, | |
| comment_id: existing.id, | |
| body, | |
| }); | |
| } else { | |
| // Create a new comment | |
| await github.rest.issues.createComment({ | |
| owner: context.repo.owner, | |
| repo: context.repo.repo, | |
| issue_number: pr_number, | |
| body, | |
| }); | |
| } |