Merge pull request #31 from datajoint/feature/ghactions

add PyPI publishing workflow

Author: dimitri-yatsenko

.github/workflows/publish-to-pypi.yml

@@ -1,34 +1,78 @@
-name:  Release to PyPI
+name: Publish to PyPI
 
 on:
-  push:
-    tags:
-       - '*'
+  release:
+    types:
+      - published
+  workflow_dispatch:
 
 jobs:
-  deploy:
+  dist:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
 
+      - name: Build and inspect package
+        uses: hynek/build-and-inspect-python-package@v2
+
+  publish:
+    needs: dist
     runs-on: ubuntu-latest
+    if: github.event_name == 'release' && github.event.action == 'published'
 
     steps:
-      - uses: actions/checkout@v2
-      - name: Set up Python 3.9
-        uses: actions/setup-python@v2
+      - name: Download built artifacts
+        uses: actions/download-artifact@v4
         with:
-          python-version: 3.9
-      - name: Install dependencies for testing
-        run: |
-          pip install pytest
-          pip install zarr
-          pip install setuptools wheel twine
-          pip install .
-      - name: Test core with pytest
+          name: Packages
+          path: dist
+
+      - name: Configure publish credentials
+        id: publish-config
+        env:
+          RELEASE_NAME: ${{ github.event.release.name }}
+          DEFAULT_USERNAME: ${{ secrets.twine_username }}
+          DEFAULT_PASSWORD: ${{ secrets.twine_password }}
+          TEST_USERNAME: ${{ secrets.twine_test_username }}
+          TEST_PASSWORD: ${{ secrets.twine_test_password }}
         run: |
-          pytest -v
-      - name: Publish on PyPI
+          set -euo pipefail
+
+          repository="pypi"
+          username="$DEFAULT_USERNAME"
+          password="$DEFAULT_PASSWORD"
+
+          if [[ -n "${RELEASE_NAME}" && "${RELEASE_NAME}" =~ ^[Tt]est ]]; then
+            if [[ -z "${TEST_USERNAME}" || -z "${TEST_PASSWORD}" ]]; then
+              echo "::error::Test PyPI credentials are required for releases starting with 'Test'"
+              exit 1
+            fi
+            repository="testpypi"
+            username="$TEST_USERNAME"
+            password="$TEST_PASSWORD"
+          fi
+
+          if [[ -z "${username}" || -z "${password}" ]]; then
+            echo "::error::PyPI credentials are not configured"
+            exit 1
+          fi
+
+          {
+            echo "repository=${repository}"
+            echo "username=${username}"
+            echo "password=${password}"
+          } >> "$GITHUB_OUTPUT"
+
+      - name: Publish distribution
         env:
-          TWINE_USERNAME: __token__
-          TWINE_PASSWORD: ${{ secrets.AIND_PYPI_TOKEN }}
+          TWINE_USERNAME: ${{ steps.publish-config.outputs.username }}
+          TWINE_PASSWORD: ${{ steps.publish-config.outputs.password }}
+          TWINE_REPOSITORY: ${{ steps.publish-config.outputs.repository }}
         run: |
-          python setup.py sdist
-          twine upload dist/*
+          python -m pip install --upgrade pip
+          python -m pip install twine
+          twine upload --repository "${TWINE_REPOSITORY}" dist/*

LICENSE

@@ -1,6 +1,7 @@
 MIT License
 
-Copyright (c) 2024, Allen Institute for Neural Dynamics, DataJoint Inc, CatalystNeuro, and contributors
+Copyright (c) 2024, Allen Institute for Neural Dynamics, DataJoint Inc., CatalystNeuro, and contributors
+Copyright (c) 2025, DataJoint Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

pyproject.toml

@@ -206,4 +206,4 @@ checks = [
 ]
 
 [tool.codespell]
-ignore-words-list = "Nd"
+ignore-words-list = "Nd"