From 3ab2ecd8cb8eaf26c1bc3f1eba84a458f149a8cd Mon Sep 17 00:00:00 2001 From: Wei Ji <23487320+weiji14@users.noreply.github.com> Date: Tue, 7 Jun 2022 16:59:00 -0400 Subject: [PATCH] :package: Publish to TestPyPI and PyPI using GitHub Actions (#14) Building the binary wheel and source tarball packages with `poetry build` and publishing to TestPyPI and PyPI via GitHub Actions. * :package: Publish to TestPyPI and PyPI using GitHub Actions Automating the binary wheel and source tarball publishing to TestPyPI and PyPI. Based on https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows but using `poetry` to do the build. * :green_heart: Fix version string to be PEP440 compliant for TestPyPI Change from semver to PEP440 and remove the git hash part of the version string when uploading to TestPyPI. Based on https://github.com/mtkennerly/poetry-dynamic-versioning/issues/78#issuecomment-1131775192. Prevents errors like `'0.0.0.post15+f899e49' is an invalid value for Version. Error: Can't use PEP 440 local versions. See https://packaging.python.org/specifications/core-metadata for more information`. * :speech_balloon: Include TestPyPI installation instructions So that people can get the latest development package from https://test.pypi.org/project/zen3geo. Also centering the title on the webpage. * :speech_balloon: Update dev status from 1 planning to 3 alpha Jumping two steps ahead, why drive when you can fly? --- .github/workflows/publish-to-pypi.yml | 71 +++++++++++++++++++++++++++ README.md | 6 ++- docs/index.md | 8 ++- pyproject.toml | 6 ++- 4 files changed, 86 insertions(+), 5 deletions(-) create mode 100644 .github/workflows/publish-to-pypi.yml diff --git a/.github/workflows/publish-to-pypi.yml b/.github/workflows/publish-to-pypi.yml new file mode 100644 index 0000000..2cab66f --- /dev/null +++ b/.github/workflows/publish-to-pypi.yml @@ -0,0 +1,71 @@ +# Publish archives to PyPI and TestPyPI using GitHub Actions +# https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/ + +name: Publish to PyPI + +# Only run for pushes to the main branch and releases. +on: + push: + branches: + - main + release: + types: + - published + # Runs for pull requests should be disabled other than for testing purposes + #pull_request: + # branches: + # - main + +permissions: + contents: read + +jobs: + publish-pypi: + name: Build and publish Python 🐍 distributions 📦 to PyPI and TestPyPI + runs-on: ubuntu-22.04 + if: github.repository == 'weiji14/zen3geo' + + steps: + - name: Checkout + uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b + with: + # fetch all history so that poetry-dynamic-versioning works + fetch-depth: 0 + + - name: Set up Python 3.9 + uses: actions/setup-python@98f2ad02fd48d057ee3b4d4f66525b231c3e52b6 + with: + python-version: '3.9' + + - name: Install Poetry and dynamic-versioning plugin + run: | + pip install poetry==1.2.0b1 + poetry plugin add poetry-dynamic-versioning-plugin + poetry show + + - name: Fix up version string for TestPyPI + if: ${{ !startsWith(github.ref, 'refs/tags') }} + run: | + # Change poetry-dynamic-versioning to use metadata=false so that the + # local part of the version isn't included, making the version string + # compatible with PyPI. + sed --in-place "s/metadata = true/metadata = false/g" pyproject.toml + + - name: Build a binary wheel and a source tarball + run: | + poetry build -vvv + echo "" + echo "Generated files:" + ls -lh dist/ + + - name: Publish distribution 📦 to Test PyPI + uses: pypa/gh-action-pypi-publish@0fc90bca7acbb84292e0cff399f8579284fcfc7d + with: + password: ${{ secrets.TEST_PYPI_API_TOKEN }} + repository_url: https://test.pypi.org/legacy/ + + - name: Publish distribution 📦 to PyPI + if: startsWith(github.ref, 'refs/tags') + uses: pypa/gh-action-pypi-publish@0fc90bca7acbb84292e0cff399f8579284fcfc7d + with: + password: ${{ secrets.PYPI_API_TOKEN }} diff --git a/README.md b/README.md index 02a44f2..6ab382e 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,10 @@ Look out, sense within, and now you must know ## Installation -For now, install from source using +To install the development version from GitHub, do: pip install git+https://github.com/weiji14/zen3geo.git + +Or from [TestPyPI](https://test.pypi.org/project/zen3geo): + + pip install --pre --extra-index-url https://test.pypi.org/simple/ zen3geo diff --git a/docs/index.md b/docs/index.md index 555f8c5..619eadc 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,7 +1,11 @@ -# ☯ *zen3geo* - The 🌏 data science library you've been waiting for +#
☯ *zen3geo* - The 🌏 data science library you've been waiting for
## Installation -For now, install from source using +To install the development version from GitHub, do: pip install git+https://github.com/weiji14/zen3geo.git + +Or from [TestPyPI](https://test.pypi.org/project/zen3geo): + + pip install --pre --extra-index-url https://test.pypi.org/simple/ zen3geo diff --git a/pyproject.toml b/pyproject.toml index f766a0e..fb45b68 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -6,7 +6,7 @@ authors = ["Wei Ji <23487320+weiji14@users.noreply.github.com>"] license = "LGPL-3.0-or-later" readme = "README.md" classifiers = [ - "Development Status :: 1 - Planning", + "Development Status :: 3 - Alpha", "Intended Audience :: Science/Research", "License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)", "Topic :: Scientific/Engineering", @@ -38,8 +38,10 @@ docs = [ ] [tool.poetry-dynamic-versioning] +bump = true enable = true -style = "semver" +metadata = true +style = "pep440" [build-system] requires = ["poetry>=1.2.0b1", "poetry-dynamic-versioning"]