diff --git a/.github/workflows/pypi-release.yaml b/.github/workflows/pypi-release.yaml new file mode 100644 index 0000000..cd4899d --- /dev/null +++ b/.github/workflows/pypi-release.yaml @@ -0,0 +1,102 @@ +name: Build and Upload xbatcher to PyPI +on: + release: + types: + - published + # Runs for pull requests should be disabled other than for testing purposes + #pull_request: + # branches: + # - main + +permissions: + contents: read + +jobs: + build-artifacts: + runs-on: ubuntu-latest + if: github.repository == 'xarray-contrib/xbatcher' + steps: + - uses: actions/checkout@v3 + with: + fetch-depth: 0 + - uses: actions/setup-python@v4 + name: Install Python + with: + python-version: 3.8 + + - name: Install dependencies + run: | + python -m pip install --upgrade pip + python -m pip install build twine + + # This step is only necessary for testing purposes and for TestPyPI + - name: Fix up version string for TestPyPI + if: ${{ !startsWith(github.ref, 'refs/tags') }} + run: | + # Change setuptools-scm local_scheme to "no-local-version" so the + # local part of the version isn't included, making the version string + # compatible with PyPI. + sed --in-place "s/dirty-tag/no-local-version/g" pyproject.toml + + - name: Build tarball and wheels + run: | + git clean -xdf + git restore -SW . + python -m build + - name: Check built artifacts + run: | + python -m twine check --strict dist/* + pwd + if [ -f dist/xbatcher-0.0.0.tar.gz ]; then + echo "❌ INVALID VERSION NUMBER" + exit 1 + else + echo "✅ Looks good" + fi + - uses: actions/upload-artifact@v3 + with: + name: releases + path: dist + + test-built-dist: + needs: build-artifacts + runs-on: ubuntu-latest + steps: + - uses: actions/setup-python@v4 + name: Install Python + with: + python-version: 3.8 + - uses: actions/download-artifact@v3 + with: + name: releases + path: dist + - name: List contents of built dist + run: | + ls -ltrh + ls -ltrh dist + - name: Verify the built dist/wheel is valid + run: | + python -m pip install --upgrade pip + python -m pip install dist/xbatcher*.whl + python -m xbatcher.util.print_versions + - name: Publish package to TestPyPI + uses: pypa/gh-action-pypi-publish@v1.5.1 + with: + password: ${{ secrets.TEST_PYPI_API_TOKEN }} + repository_url: https://test.pypi.org/legacy/ + # verbose: true + + upload-to-pypi: + needs: test-built-dist + if: github.event_name == 'release' + runs-on: ubuntu-latest + steps: + - uses: actions/download-artifact@v3 + with: + name: releases + path: dist + - name: Publish package to PyPI + uses: pypa/gh-action-pypi-publish@v1.5.1 + with: + password: ${{ secrets.PYPI_API_TOKEN }} + # verbose: true diff --git a/doc/contributing.rst b/doc/contributing.rst index 803d2bc..31ebd04 100644 --- a/doc/contributing.rst +++ b/doc/contributing.rst @@ -246,3 +246,5 @@ Continuous integration is done with `GitHub Actions `_ - Run test suite with pytest. +- `pypi-release.yaml `_ - Publish + wheels to TestPyPI and PyPI on a tagged release. The pull request trigger can be uncommented to test a release using Test PyPI. diff --git a/pyproject.toml b/pyproject.toml index 110eafb..e741d94 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -6,22 +6,23 @@ requires = [ build-backend = "setuptools.build_meta" [project] -name = 'xbatcher' -description = 'Batch generation from Xarray objects' +name = "xbatcher" +description = "Batch generation from Xarray objects" +readme = "README.rst" license = {text = "Apache"} authors = [{name = "xbatcher Developers", email = "rpa@ldeo.columbia.edu"}] requires-python = ">=3.8" classifiers = [ - 'Development Status :: 4 - Beta', + "Development Status :: 4 - Beta", "License :: OSI Approved :: Apache Software License", - 'Operating System :: OS Independent', - 'Intended Audience :: Science/Research', - 'Programming Language :: Python', - 'Programming Language :: Python :: 3', - 'Programming Language :: Python :: 3.8', - 'Programming Language :: Python :: 3.9', - 'Programming Language :: Python :: 3.10', - 'Topic :: Scientific/Engineering', + "Operating System :: OS Independent", + "Intended Audience :: Science/Research", + "Programming Language :: Python", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Topic :: Scientific/Engineering", ] dynamic = ["version"] dependencies = [ @@ -53,12 +54,12 @@ repository = "https://github.com/xarray-contrib/xbatcher" include = ["xbatcher*"] [tool.setuptools_scm] -version_scheme = 'post-release' -local_scheme = 'dirty-tag' +version_scheme = "post-release" +local_scheme = "dirty-tag" fallback_version = "999" [tool.isort] -profile = 'black' +profile = "black" known_third_party = ["numpy", "pytest", "setuptools", "sphinx_autosummary_accessors", "torch", "xarray"] [tool.pytest.ini_options] diff --git a/xbatcher/util/print_versions.py b/xbatcher/util/print_versions.py index 122140c..2eed240 100644 --- a/xbatcher/util/print_versions.py +++ b/xbatcher/util/print_versions.py @@ -63,3 +63,7 @@ def _get_module_version(modname): print("Dependency information:", file=file) for modname in deps: print(f" {modname}: {_get_module_version(modname)}", file=file) + + +if __name__ == "__main__": # pragma: no cover + show_versions()