Skip to content

Add docstrings

Add docstrings #6

Workflow file for this run

name: Build and upload to PyPI
on:
workflow_dispatch:
pull_request:
push:
branches:
- main
release:
types:
- published
jobs:
# build_wheels:
# name: Build wheels on ${{ matrix.os }}
# runs-on: ${{ matrix.os }}
# strategy:
# matrix:
# os: [ubuntu-22.04, windows-2022, macos-11]
# steps:
# - uses: actions/checkout@v4
# - name: Build wheels
# uses: pypa/cibuildwheel@v2.15.0
# env:
# CIBW_BUILD: cp39-* cp310-*
# CIBW_ARCHS_MACOS: "x86_64 universal2 arm64"
# CIBW_ARCHS_LINUX: auto64
# CIBW_ARCHS_WINDOWS: auto64
# CIBW_BUILD_FRONTEND: build
# - uses: actions/upload-artifact@v3
# with:
# path: ./wheelhouse/*.whl
build_sdist:
name: Build source distribution
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Build sdist
run: pipx run build --sdist
- uses: actions/upload-artifact@v3
with:
path: dist/*.tar.gz
upload_test_pypi:
needs: [build_sdist] #[build_wheels, build_sdist]
runs-on: ubuntu-latest
if: github.event_name == 'release' && github.event.action == 'published'
# or, alternatively, upload to PyPI on every tag starting with 'v' (remove on: release above to use this)
# if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
steps:
- uses: actions/download-artifact@v3
with:
# unpacks default artifact into dist/
# if `name: artifact` is omitted, the action will create extra parent dir
name: artifact
path: dist
- uses: pypa/gh-action-pypi-publish@release/v1
with:
password: ${{ secrets.TEST_PYPI_TOKEN }}
repository-url: https://test.pypi.org/legacy/
upload_pypi:
needs: [build_sdist, upload_test_pypi] #[build_wheels, build_sdist, upload_test_pypi]
runs-on: ubuntu-latest
# Add these back after setting up trusted publishing
# environment: pypi
# permissions:
# id-token: write
if: github.event_name == 'release' && github.event.action == 'published'
# or, alternatively, upload to PyPI on every tag starting with 'v' (remove on: release above to use this)
# if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
steps:
- uses: actions/download-artifact@v3
with:
# unpacks default artifact into dist/
# if `name: artifact` is omitted, the action will create extra parent dir
name: artifact
path: dist
- uses: pypa/gh-action-pypi-publish@release/v1
with:
password: ${{ secrets.PYPI_TOKEN }}