Skip to content

Update README.md

Update README.md #88

Workflow file for this run

name: Deploy
# Build on every branch push, tag push, and pull request change:
on:
push:
branches: [main]
paths-ignore:
- 'docs/**'
- 'benchmarking/**'
- 'demos/**'
- 'workflows/pages.yml'
- 'workflows/build.yml'
pull_request:
branches: [main]
paths-ignore:
- 'docs/**'
- 'benchmarking/**'
- 'demos/**'
- 'workflows/pages.yml'
- 'workflows/build.yml'
release:
types: [created]
jobs:
build_wheels:
name: build (${{ matrix.os }})
runs-on: ${{ matrix.os }}
strategy:
fail-fast: true
matrix:
os: [ubuntu-latest, macos-latest, windows-latest]
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Build wheels
uses: pypa/[email protected] #2.19.2
env:
CIBW_ARCHS_MACOS: x86_64 arm64
- uses: actions/upload-artifact@v4
with:
path: ./wheelhouse/*.whl
name: artifacts-${{ matrix.os }}
build_sdist:
name: build dist
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Build sdist
run: pipx run build --sdist
- uses: actions/upload-artifact@v4
with:
path: dist/*.tar.gz
name: artifacts-sdist
upload_all:
name: publish (PyPI)
needs: [build_wheels, build_sdist]
runs-on: ubuntu-latest
# upload to PyPI on release event
if: github.event_name == 'release' && success()
steps:
- uses: actions/setup-python@v5
with:
python-version: "3.x"
- uses: actions/download-artifact@v4
with:
pattern: artifacts-*
path: dist
merge-multiple: true
- uses: pypa/[email protected]
with:
password: ${{ secrets.PYPI_API_TOKEN }}
skip-existing: true
verbose: true
update_citation:
name: update CITATION
needs: [upload_all]
runs-on: ubuntu-latest
if: github.event_name == 'release' && success()
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Download Zenodo CFF
run: |
curl -L https://zenodo.org/records/14199059/export/cff -o CITATION.cff
sed -i '/^abstract:/,/^authors:/d' CITATION.cff
sed -i '1iauthors:' CITATION.cff
- name: Update CITATION.cff
run: |
python -m pip install --upgrade pip
pip install cffconvert
cffconvert --output-format=cff-citation-file --output-path=CITATION.cff setup.py
- name: Commit CITATION.cff
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
git config --global user.name "github-actions[bot]"
git config --global user.email "github-actions[bot]@users.noreply.github.com"
git add CITATION.cff
git diff-index --quiet HEAD || git commit -m "Update citation" --allow-empty
git push